Skip to content

Commit

Permalink
docs: create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
arxanas committed Aug 22, 2022
1 parent d6f726b commit 3357c8c
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions CONTRIBUTING.md
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
```

0 comments on commit 3357c8c

Please sign in to comment.