Skip to content

Latest commit

 

History

History
30 lines (23 loc) · 1.77 KB

CONTRIBUTING.md

File metadata and controls

30 lines (23 loc) · 1.77 KB

Cool! We love to see that you're thinking about Contributing!

You can contribute to this project by filing issues, bugs and reports.
We're also happy when you take a look at open issues and engage in discussions or even make a contribution by fixing one of them. Good starting points are issues marked with Good First Issue or even Help Wanted!
We want to make contributing to this project as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer
  • Or everything else basically

If you want to discuss on something then feel free to present your opinions, views or any other relevant comment in the Discussions.
To help feel everyone at home, we have a Code Of Conduct that everyone has to follow in all our interactions with the project and each other.

Code Contribution

  • Open issues regarding proposed change
  • If your proposed change is approved, fork this repo and do changes
  • Open a PR against latest main branch and add a nice and informative description in your PR, describing your change and why it helps
  • Wait for review and fix possible findings
  • You're done, thanks!

Code contribution checklist

  • New code addition/deletion should not break existing flow of a system
  • Ensure that any (development) dependencies are actually necessary for the change that you're implementing
  • Update the README if there are any changes to the public API and/or configuration