Skip to content

Commit dacc631

Browse files
authored
Adding a contributing guide (#826)
* Create CONTRIBUTING.md * Add links on how to create issues and PRs * Incorporate comments * fix link
1 parent 8860479 commit dacc631

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

docs/CONTRIBUTING.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# How to contribute to PISA
2+
3+
Thank you for reading this and for considering to contribute to PISA! We always need volunteer developers to help move this project forward.
4+
5+
## Submitting changes
6+
Found a bug or missing a feature? Don't be afraid to tackle this! If you don't do it, maybe no one will.
7+
8+
#### Create an issue
9+
In any case, it is a good first step to document what you have found (or what is missing) in a GitHub issue. [Here](https://docs.github.com/en/issues/tracking-your-work-with-issues/creating-an-issue) is how to do it.
10+
11+
#### Close an issue
12+
You are more than welcome to work on something already documented! But remember, the best way to close an issue is with a pull request.
13+
14+
#### Open a pull request
15+
Once you implemented your changes, you can start a PR. You can start this early, even when you are still working on your code, to get feedback and let people know what you are working on. Use your own fork and a dedicated branch for your PR. [Here](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) is how to do it.
16+
17+
#### Review a pull request
18+
Everyone can (and should) review PRs opened by other contributors. This input is very valuable for the PR creator as well as other reviewers.
19+
20+
## Coding conventions
21+
Coding conventions can be found in [Conventions](https://github.com/icecube/pisa/blob/master/pisa/general_conventions.md).
22+
23+
## Testing
24+
If you add a feature, add a test that proves it works. More about tests can be found in [Conventions](https://github.com/icecube/pisa/blob/master/pisa/general_conventions.md).
25+
26+
## Ask for help
27+
If you are stuck with your code or have some general questions, feel free to ask other people on slack (e.g. in the pisa-help channel). If you are not a member of the IceCube collaboration, you can create an issue with your question.
28+
29+
**Thanks a lot and good coding :)**

0 commit comments

Comments
 (0)