Contributing

Translations

If you are willing and able to provide a translation, please follow the following instructions (where CODE is the language code that you're translating for, eg 'en'):

1. Fork this repository
2. Branch off master (ie git checkout master && git pull origin master && git checkout -b feature/language-CODE)
3. Copy src/js/locale/en.yaml to src/js/locale/CODE.yaml
4. Work through the file, translating as you go. The YAML file structure loosely reflects where you would encounter the phrases in the interface. Do not change any text between ${}, eg ${number}.
5. Create a pull request with your completed translation.

Please be mindful that translations require maintenance and regular updating as Iris itself evolves. If you are going to contribute a new translation, please make sure you will be available to provide translation updates in the future.

Bugfixes and improvements

If you have an exciting feature or bugfix that you have developed and would like to introduce into the official Iris product, please feel free to create a pull request for review. However there are a few important points to note:

• All pull requests should be related to an issue that describes the problem to be solved
• Merge to and from master branch
• Include unit tests