We sincerely welcome contributions, both in codes and in other forms. This file describes general guideline for contributing.
There isn't a strict standard on contribution types, here are some directions to consider:
- Fix a bug: If you find a bug yourself or find some bug listed under Issues solvable, you are welcome to fix it.
- Add new functions according to requirements: If you notice users' requirements for some interesting functions and you want to contribute, feel free to communicate with us and we are happy to update our web-extension to include more features.
- Translation and documentation: You are welcomed to create new branches to translate existed version for other languages. You are also welcomed to help accomplishing documentation for this web-extension.
If you aim at helping us adding new functions, you should make sure that the new functions are consistent with the goal and values of this addon and our community. When adding a new function, you should create a new branch. Please do not change the main branch. We also welcome you to discuss with the leadership and you can find the discord channel here.
If you are aditing an existing file or adding new code files, code style should be consistent with the rest of the code in the file and other existing files. Please comment when necessary. At the same time, if there are references, please include them as comment at the beginning of the code file. For more general standard, follow the guideline here.
If you would like to contribute to our documentation. You should check the grammar first. You should write in a clear way and avoid complicated long sentences. Using graphs and examples as complimentary explanation is recommended. At the same time, if there are references, please state them clearly.
Please note that the examples are all made available under the Mozilla Public License 2.0, so any contributions must be compatible with that license. Ask the leadership if you have any questions.
Template for this document is adapted from MDN Web Extensions.