|
| 1 | +# Contributing to Ponos |
| 2 | + |
| 3 | +Thank you for your interest in contributing to the Ponos project! We appreciate |
| 4 | +contributions via submitting Github issues and/or pull requests. |
| 5 | + |
| 6 | +Below are some guidelines to follow when contributing to this project: |
| 7 | + |
| 8 | +* Before opening an issue in Github, check [open issues](https://github.com/goadesign/ponos/issues) |
| 9 | + and [pull requests](https://github.com/goadesign/ponos/pulls) for existing |
| 10 | + issues and fixes. |
| 11 | +* If your issue has not been addressed, [open a Github issue](https://github.com/goadesign/ponos/issues/new) |
| 12 | + and follow the checklist presented in the issue description section. A simple |
| 13 | + code snippet that reproduces your issue helps immensely. |
| 14 | +* If you know how to fix your bug, we highly encourage PR contributions. See |
| 15 | + [How Can I Get Started section](#how-can-i-get-started) on how to submit a PR. |
| 16 | +* For feature requests and submitting major changes, [open an issue](https://github.com/goadesign/ponos/issues/new) |
| 17 | + or hop on to our slack channel (see <https://goa.design> to join) to discuss |
| 18 | + the feature first. |
| 19 | +* Keep conversations friendly! Constructive criticism goes a long way. |
| 20 | +* Have fun contributing! |
| 21 | + |
| 22 | +## How Can I Get Started? |
| 23 | + |
| 24 | +1) Go over the package README |
| 25 | +2) To get your hands dirty, fork the Ponos repo and issue PRs from the fork. |
| 26 | +**PRO Tip:** Add a [git remote](https://git-scm.com/docs/git-remote.html) to |
| 27 | +your forked repo in the Ponos source code (in $GOPATH/src/goa.design/ponos when |
| 28 | +installed using `go get`) to avoid messing with import paths while testing |
| 29 | +your fix. |
| 30 | +3) [Open issues](https://github.com/goadesign/ponos/issues) labeled as `good first |
| 31 | +issue` are ideal to understand the source code and make minor contributions. |
| 32 | +Issues labeled `help wanted` are bugs/features that are not currently being |
| 33 | +worked on and contributing to them are most welcome. |
| 34 | +4) Link the issue that the PR intends to solve in the PR description. If an issue |
| 35 | +does not exist, adding a description in the PR that describes the issue and the |
| 36 | +fix is recommended. |
| 37 | +5) Ensure the CI build passes when you issue a PR to Ponos. |
| 38 | +6) Join our slack channel (see <https://goa.design> to join)! |
0 commit comments