Your contributions are welcome in the form of pull requests. To ease review and, more importantly, for timely reviews of bug-fixes and features, please follow the following guidelines when opening pull requests:
- Follow the Conventional Commits to format your commit headings and messages - extra credits for detailed explanantion of your proposed changes in the main commit message.
- For bug-fixes and minor changes to interface and behaviors, please submit your patches to the
masterbranch for inclusion in the current "major" series. - For overhauls, refactors, and new features, please submit your patches to the
nextbranch for inclusion in the next "major" series.
By and large, oma follows semantic versioning and uses a three-segment versioning scheme (x.y.z):
- X: Major series, for major features, overhauls, and function refactors.
- Y: Minor series, for minor changes to interface to behaviors.
- Z: Patch series, for bugfixes only.
Pre-Commit Configuration
Pre-commit is a standard tool for git hooks
We recommend that contributors use pre-commit hooks to check for linting issues and typos before committing and pushing changes. However, this step is OPTIONAL and can be safely ignored if preferred.
- pre-commit-hooks (Basic Hooks):
- trailing-whitespace
- end-of-file-fixer
- check-yaml
- check-added-large-files
- rustfmt
- clippy format
- typos
- Install
pre-commitfrom pip or package managers:
Example:
# For arch user:
pacman -S pre-commit
# For pip user:
pip install -S pre-commit
There is no pre-commit package in AOSC repos yet.
Currently in AOSC OS, pip is for python2, please use pip3 or venv/conda!
- Install pre-commit hooks:
# In the root of repo:
pre-commit install
- Test configuration
pre-commit run -a
Your pull requests would notify all contributors. If you want to expedite things, consider joining our chat groups for a good scream. ;-)