Create CONTRIBUTING.md

This commit is contained in:
Julian Frohmüller
2022-12-05 13:48:43 +01:00
committed by GitHub
parent 16c2a52acb
commit dee906a182
+16
View File
@@ -0,0 +1,16 @@
## How to contribute to OpenSuperClone
Thank your for considering to contribute to OpenSuperClone! To get an overview of the project, read the <a href="README.md">README</a>.
### Reporting Bugs
* Ensure the bug was not already reported by searching on Github under <a href="https://github.com/ISpillMyDrink/OpenSuperClone/issues">Issues</a>.
* If you're unable to find an open issue addressing the problem, <a href="https://github.com/ISpillMyDrink/OpenSuperClone/issues/new/choose">open a new one</a>. Be sure to include a clear description of the issue, the version number and revision number of OpenSuperClone (can be found under Help->About), and any other information relevant to reproducing the problem.
### Fixing Bugs & Adding new Features
* Open a new Github pull request with the patch you have written
* Make sure the request description clearly describes the problem and solution, or feature the patch implements. Include a link to the relevant issue if applicable.
* Before submitting, please make sure the patch is stable and matches the coding and style conventions used in the source code
### Translations
OpenSuperClone uses <a href="https://www.gnu.org/software/gettext/">gettext</a> for localization. Template files are located in `src/opensuperclone/locale` and `src/oscviewer/locale`.
* Open a new Github pull request with the translation file you have written