Thank you for considering contributing to zaman!
With the exception of the general rules (which must be acknowledged and applied in any contribution / interaction in this project), these guidelines represent an ideal target & standards that I would like this project to follow but may not all be strictly enforced (depending on the situation).
Please, don't refrain yourself from contributing if you feel that your contribution may not entirely follow these guidelines (or if you're struggling applying some of them). I value your contributions much more than the strict application of these guidelines!
These general rules apply to every contributions (whatever the type). They should always be acknowledged and strictly followed in any circumstances:
Basic common sense applies to every contributions & discussions: stay polite and respectful, no flaming / trolling / spamming or any kind of discrimination / harassment, avoid controversial topics (specifically if it has nothing to do with this project whatsoever), etc...
Use English as much as possible for contributions & discussions. If required, I can also speak French, but it's important that contributions & discussions remain intelligible to most people.
Before opening an issue, verify that there isn't one already open on the same (or a similar) subject.
Make sure to use the correct type for your issue (Bug Report or Feature Request) and to provide the requested information. If you have a doubt about which one is the most appropriate for your issue (or if you think that none of these types apply to your issue), feel free to use the general Other type.
Providing as much details as possible in your issue will ease its processing.
Read the following sub-chapters before opening a pull request.
Make sure to create your merge request from a dedicated branch (do not use the main branch) and to provide the information requested in the pull request template.
Apart from trivial changes (like simple typo fixes), it is advised to first open an issue to expose and discuss your changes, verify its feasibility / necessity and agree on the specifications.
When submitting code changes, try to respect the coding style and the overall way things work, as much as possible.
Bash code is checked with shellcheck.
Markdown syntax is checked with markdownlint.
Commits must follow the conventional commits specification.
This project uses the following commit types:
- chore: for internal / miscellaneous changes
- feat: for new features (or improvements / additions to existing features)
- fix: for bug fixes
- doc: for documentation only changes
- style: For changes that do not affect the meaning of the code (white-space, formatting, typo fixes, etc...)
An optional scope can be provided to the commit type if relevant (for instance when a change is specific to a precise part of the project), like so: type(scope): commit message.
If a commit introduces a breaking change, its type must contain a ! (e.g. feat!: commit message) and / or a BREAKING CHANGE: mention should be added at the end of your commit message (e.g. BREAKING CHANGE: description of the breaking change).
Here are a few examples of the expected commit format:
feat(menu): Add rofi support
Add rofi support (in addition of dmenu) for the menu option.
Closes https://github.com/Antiz96/zaman/issues/163
fix: Run the zathura process in the background
Run the zathura process in the background so people can still use their terminal while reading PDF man pages.
Fixes https://github.com/Antiz96/zaman/issues/103
doc(man): Add the -m / --menu option to man pages
The recently introduced -m / --menu option was missing from the man page
style: Typo fixes in README and man page
chore!(code structure): Split the script functions into separate libraries
Split the functions inside the main script into their own separate libraries scripts to improve readability and ease the overall maintenance and contribution processes.
Closes https://github.com/Antiz96/zaman/issues/230
BREAKING CHANGE: People that installed zaman from source will have to either uninstall it (with `make uninstall`) **before** pulling and installing the new version (with `make install`). Otherwise, some files will remain un-tracked on the system.
By contributing to this project, you agree that your contributions will be licensed under the GPL-3.0 license (or any later version of this license).
You can also support this project development (and my work in general) by making a donation via my GitHub sponsor page.
Once again, thank you for considering contributing to zaman!
I'd also like to sincerely thank everyone that gave zaman a star, opened issues, feature requests, pull requests or contributed to this project in any other way! ❤️