Create CONTRIBUTING.md

CONTRIBUTING.md

@@ -0,0 +1,40 @@
+# Contributing to HollaEx Kit
+
+We love your input! 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 contributor
+
+## How to submit an issue
+We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy! Before you do so check [forum](https://forum.hollaex.com) and see if you find the answer to your issues or questions. Also keep your issues in GitHub to only tech related topics. For not tech related matters you can contact [email protected].
+
+## How to Contribute Code
+Before you contribite any code we assume that you have read the license and accept to give the full right of your code to HollaEx for its public use. To submit a code contribution, make sure you open a Pull Request to `develop` branch describing the code change clearly in english and provide any additional information in your PR. Follow the code format used in the project and run prettier as well as eslint configuration set in the project. 
+
+## Language Support
+Language strings are stored in web as well as emails. To add a new language you need to create a new language file in both [web](https://github.com/bitholla/hollaex-kit/tree/master/web/src/config/lang) and [mail](https://github.com/bitholla/hollaex-kit/blob/master/server/mail/strings) following [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) standard.
+
+### web
+You can start by copying en.js file and rename `en` to the new ISO 639-1 language and start translating. Some notes to remember when doing the translation:
+
+- Do not change the file keys. For example in `APP_TITLE: 'HollaEx'`. `APP_TITLE` should not be changed since it is used as an identifier.
+- Keep the JavaScript object format and do not change string quotes such as `''`, commas `,` etc.
+- Do not remove numbers in brackets such as `{0}` or `{1}` etc. These are dynamic values such as the coin name etc and should not be changed. You need to just rearrange the placement of such words in the sentence if necessary.
+- Custom code cases such as the example below are rare but can be found in the file. In these cases please read the comment in front of them.
+```
+TYPES: [
+  { value: 'market', label: 'market' }, // DO NOT CHANGE value, ONLY TRANSLATE label
+  { value: 'limit', label: 'limit' }, // DO NOT CHANGE value, ONLY TRANSLATE label
+]
+```
+In this case only translate the label and do not change value.
+
+ ### mail
+ Just like web strings the are emails that should be supported for each new language. Start by copying [this english translation file](https://github.com/bitholla/hollaex-kit/blob/develop/server/mail/strings/en.json) similar to the web and add all the new email translations into this json file.
+ Please keep in mind not to change dynamic variables inside `${}` such as `${email}` and html tags such as `<p>` or `</p>`.
+
+ ## Discussion 
+ We use GitHub strictly to code and do not use it for general discussions. For general discussions with others in the community and sharing your ideas, feature request you can use [Discord](https://discord.gg/ZN45kTdFd3) and make sure to check [Forum](https://forum.hollaex.com) posts for any questions you have.