hedgedoc/CONTRIBUTING.md
Philip Molares 8c84ab7005
Create CONTRIBUTING.md (#402)
Create CONTRIBUTING.md
fixes #70 

Co-authored-by: mrdrogdrog <mr.drogdrog@gmail.com>
Co-authored-by: Erik Michelson <github@erik.michelson.eu>
2020-08-12 23:12:59 +02:00

1.8 KiB

How to contribute to HedgeDoc react-client

Thanks for your interest in contributing. Here are some common scenarios for what you may want to contribute to.

Do you have questions about the project?

Did you find a bug?

  • Ensure the bug wasn't already reported by searching on GitHub under Issues.

  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to use one of the templates we provide if your request applies to them. If not, use the 'Question / Other' template.

Did you write a patch that fixes a bug?

  • Open a new GitHub pull request with the patch.

  • Ensure the PR description is precise about the problem and your solution. Just fill out our template. That should cover the most important information.

Do you intend to add a new feature or change an existing one?

  • Suggest your idea in the HedgeDoc Dev Channel and start writing code. Our maintainers and other project developers can provide useful details about the architecture and show you relevant issues and discussions.

Do you want to work on translations?

If you want to improve a translation or add a new translation altogether, we handle those via POEditor.

HedgeDoc is a volunteer effort. We encourage you to pitch in and to help us making this project even better.

Thanks! ❤️ ❤️ ❤️