-
Notifications
You must be signed in to change notification settings - Fork 22
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
17 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
# How to contribute | ||
|
||
`focus` development is done entirely on Github. To discuss, use the [issue tracker](https://github.com/twitter/focus/issues) or [discussion board](https://github.com/twitter/focus/discussions). | ||
|
||
To contribute, open a new pull request against the `main` branch. As part of the pull request, you will be prompted by a bot to sign our CLA if you haven't done so already. | ||
|
||
To build and test the code, run | ||
|
||
```sh | ||
$ cargo test --workspace | ||
``` | ||
|
||
If you create a new file, you should add a license header. (This will be checked in CI.) You can do this with the following script: | ||
|
||
```sh | ||
$ scripts/add-license.sh | ||
``` |