Contributing

If you are interested in contributing, welcome! This app is still very new, there's lots of places need to be worked on, lots of refactor opportunities and lots of new feature can be added. To get started, take a look at the Issues page and feel free to tackle any of the open issues. For first timers, we use the label good first issue to identify small, easy issues to help you get started.

Code of Conduct

Before you begin, please read the code of conduct to help promote a welcome, inclusive and fun environment.

Submitting Issues

Before submitting an issue, please search for existing ones and utilize them as much as possible. Also, consider using the issue templates to help format your issues. The templates are just recommendations, as long as the issue is descriptive, clear and concise, it's acceptable.

Please kindly contribute, submit issues in English.

Any duplicated issues will be closed with link to possible duplication and any non-descriptive, confusing issues will be closed.

Always an Improvement

The following tasks are always welcomed and you don't need to open a separate issue.

• Add tests (provided that the test are testing meaningful areas)
• Documentation (either to the wiki page, or in the code base)

Branches

You are encouraged to work on an issue on a separate branch, then open a PR to develop. The following branches are always maintained.

• master: Current master branch, cannot be pushed to without opening PR.
• develop: Main develop branch, PR from feature/issue branches are preferred over directly pushing to develop.
• patch: For upcoming patch release of the current version.