Thank you for your interest in contributing to the ShortMath project.
- Report issues
- Fix typos and grammar
- Add new rules
- Improve existing rules and workflow
- Bugfixes should only contain changes that are related to the purpose of the bug.
- Description should contain an explanation for the proposed changes.
- It's recommended to consult feature requests with the team before starting implementation
- Send us an email if you need assistance with any work.
- Fork this repository on GitHub
- All development work should follow the GitFlow branching model.
- Make sure you have added the necessary tests for your changes.
- If applicable, include a link to the issue in the commit message body.
- Push your changes to a topic branch in your fork of the repository.
- Submit a pull request to the repository in the KQMATH GitHub organization and choose branch you want to patch (usually develop).
- Add detail about the change to the pull request including screenshots if the change affects the UI.
- After submitting a pull request, one of ShortMath team members will review it.
- Changes may be requested to conform to our style guide and internal requirements.
- When the changes are approved and all tests are passing, a ShortMath team member will merge them.
- Note: if you have write access to the repository, do not directly merge pull requests. Let another team member review your pull request and approve it.
- This repository uses Markdown syntax.
- The preferred spelling of English words is the American English (e.g. behavior, not behaviour).
- The required coding style is the Moodle cooding style.
By contributing to this repository you agree that all contributions are subject to the GNU General Public License v3.0 under thepublic domain. See LICENSE file for more information.
- Each addition and rule change is discussed and reviewed internally by ShortMath core team.
- When contents are updated, CHANGELOG.md file is updated and a new tag is released. Repository follows semantic versioning.
- The official release at Moodle must be manually updated accordingly.