From 491fcc9614c1dd4417a611a25d602efe92d0e521 Mon Sep 17 00:00:00 2001 From: simplePCBuilding <98422316+simplePCBuilding@users.noreply.github.com> Date: Fri, 16 Sep 2022 16:10:48 +0200 Subject: [PATCH] Created Contributing (markdown) --- Contributing.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 Contributing.md diff --git a/Contributing.md b/Contributing.md new file mode 100644 index 0000000..b855767 --- /dev/null +++ b/Contributing.md @@ -0,0 +1,20 @@ +Contribution in any way (contributing code, documentation, translations [No api for this created yet] and suggestions) is highly encouraged. + +# Guidelines +## Contributing Code +If you find a bug or have a cool new idea to add to this project, please feel free to open a pull request for this repo. The pull request should have the following things in it: +* What you have changed for what purpose +* If you have found any bugs in your code, what exactly are they? +* If you require some other person to do something else (e.g. translation, documentation, …) + +## Contributing documentation +You may help writing documentation by contributing to the wiki. These contributions should be for improving the language in the wiki, adding more languages, adding (more detailed) guides, … +All of this should follow these rules: +* Main language is english +* Language must be appropriate meaning it should be technical and not insulting, explicit or anything like it. + +## Translations +You may help translate this app to different languages. A future version of this app will include an API to change the language (and there will be an easy way to translate strings to different languages). Important is: +* The translations must be correct +* The translations should use the most appropriate term +* You may not use Google Translate (or any other translator) exclusively for translation. Google Translate is not accurate enough! \ No newline at end of file