diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..351ef32 --- /dev/null +++ b/CONTRIBUTING.md @@ -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 README. + +### Reporting Bugs +* Ensure the bug was not 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 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 gettext 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