Skip to content

Latest commit

 

History

History
32 lines (24 loc) · 1.51 KB

CONTRIBUTING.md

File metadata and controls

32 lines (24 loc) · 1.51 KB

How to contribute

reporting bugs

  • Use the bug template
  • Be descriptive when creating an issue (what, where, when and how does a problem pop up)?
  • Attach steps to reproduce (if applicable)
  • Attach code samples, configuration options or stack traces that may indicate a problem
  • Be helpful and respect others when commenting

feature requests

  • Use the user-story template or just put your thoughts on a note
  • Please formulate your thoughts and wishes behind the user story
  • If available, define open questions that we should discuss before starting the work
  • Define your acceptance criteria that fulfil your feature request

pull requests

Some things that make it easier for us to accept your pull requests. We also provide a pull request template

  • The code is tested
  • The code is well documented
  • The linter has nothing to note
  • The npm start build passes
  • The pull request matches our requests from the template (screenshots, problem description, description of the solution)

We'd be glad to assist you if you do not get these things right in the first place.

further reading

Maybe a look at the documentation is a good start to the work on our project. We also recommend taking a look at our Code of Conduct.

If you have any questions, don't be afraid to contact us on our mailing list.