Skip to content

Latest commit

 

History

History
48 lines (28 loc) · 2.66 KB

CONTRIBUTING.md

File metadata and controls

48 lines (28 loc) · 2.66 KB

How to contribute to PDBCleanV2

Hello! Thank you for helping us improve our project!

Please read and follow our guidelines to ensure a positive experience for contributors and maintainers.

📃 Code of Conduct

Before you start, review our Code of Conduct. Bad behavior will not be tolerated.

📨 Opening an Issue

Sign in to your GitHub account and create a New Issue in GitHub issues

Before you create a new entry, please check if the issue has already been reported in GitHub. And review our documentation.

Make sure to select an appropriate label for the issue before you submit it (e.g. bug, enhancement, etc).

🐛 Bug reports

Please write a bug report that you would like to receive.

  • Include the operating system and processor on which the code is being run on.
  • Include the location of where the issue arose.
  • If you get an error message, include it in the issue.
  • Use GitHub-flavored Markdown. Especially put code blocks and console outputs in backticks (```). This improves readability.

If an issue already exists. Comment on the existing issue to add more information or leave a reaction on their issue. This helps us become aware of which issue is being faced more commonly and allows us to prioritize which issues to solve first.

🎨 Feature request

  • Make sure to select the enhancement label when submitting an issue.
  • Be precise about the proposed outcome of the feature and how it relates to existing features. Include implementation details if possible.
  • Do not open a duplicate feature request. Search for existing feature requests first. If you find your feature (or one very similar) previously requested, comment on that issue.

🚧 Do you want to help fix an issue?

  • Comment "take" to the issue you want to fix and we will assign it to you.
  • When you submit a pull request, add the GitHub issue number in the title.
  • Only submit a pull request to issues that have been asssigned to you

💜 Credits

Written by @fatipardo and @gdkwxn.

Many of the ideas and prose for the statements in this document were based on or inspired by the contributing page written by @jessesquires