Skip to content

Latest commit

 

History

History
60 lines (34 loc) · 2.93 KB

File metadata and controls

60 lines (34 loc) · 2.93 KB

CONTRIBUTING

Please contribute!

We love collaboration. In fact, this was one of the main ideas to start the work on recapp. This includes bug reports, suggestions or even implementations of new features. Of course, you are also welcome to suggest general improvements to the package structure or to whatsoever. We appreciate any contribution and collaboration.

Code of Conduct

Please note that the recapp project is released with a Contributor Code of Conduct. By contributing to this project you agree to abide by its terms.

How to contribute

Ask a question ⁉️

Browse the documentation to see if you can find a solution. Still stuck? Open an issue on GitHub. We'll try to do our best to address it, as questions often lead to better documentation or the discovery of bugs.

If you want to ask a question in private get in contact by recapp-app@uni-goettingen.de.

Propose an idea 💡

Take a look at the documentation and issue on GitHub list to see if it isn't included or suggested yet. If not, please open a new issue!

While we can't promise to implement your idea, it helps to:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible.

Report a bug 🐛

Report it as an issue on GitHub so we can fix it. A good bug report makes it easier for us to do so, so please include:

  • Detailed steps to reproduce the bug
  • A screenshot if possible
  • Details like browser, operating system or anything about your local setup that might be helpful in troubleshooting.

Improve the documentation 📖

Good documentation makes all the difference, so your help to improve it is very welcome!

Pull request process ↕️

We try to follow the GitHub flow for development.

  1. Fork the repo and clone it to your computer. To learn more about this process, see this guide. Don't forget to pull all new changes before starting to work!

  2. Create a new Git branch and use a name that briefly describes the proposed changes.

  3. Make your changes:

    • Write your code.
    • Test your code.
    • Document your code.
  4. Commit and push your changes.

  5. Submit a pull request.

New code should follow the Google TypeScript style guide.

References

This CONTRIBUTING.md is adapted from here and here.