Skip to content

Commit 65ac26c

Browse files
Merge pull request #290 from getsentry/contributing
add CONTRIBUTING.md
2 parents 5a34987 + f38c7e5 commit 65ac26c

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

CONTRIBUTING.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
## Contributing
2+
3+
Contributions to Sentry Elixir are encouraged and welcome from everyone.
4+
5+
Before submitting code, please run the test suite, format code according to Elixir's
6+
code formatter and [Credo](https://github.com/rrrene/credo). This can be done with
7+
`mix test`, `mix format` and `mix credo`.
8+
9+
The build server will also run [dialyzer](http://erlang.org/doc/man/dialyzer.html)
10+
using [dialyxir](https://github.com/jeremyjh/dialyxir) to check the typespecs, but this can be onerous
11+
to install and run. It is okay to submit changes without running it, but can
12+
be run with `mix dialyzer` if you would like to run them yourself.
13+
14+
Once all checks are passing, you are ready to [open a pull request](https://help.github.com/articles/using-pull-requests/).
15+
16+
### Reviewing changes
17+
18+
Once a pull request is sent, the changes will be reviewed.
19+
20+
If any changes are necessary, maintainers will leave comments requesting changes
21+
to the code. This does not guarantee a pull request will be accepted, as it will
22+
be reviewed following each change.
23+
24+
Once the code is approved, your changes will be merged!

0 commit comments

Comments
 (0)