db47440d47
Improve documentation for different markdown documentation files. Goal is to simplify and make the language and content more clear.
2.3 KiB
2.3 KiB
Contributing
Love your input! Contributing to this project should be as easy and transparent as possible, whether it's:
- reporting a bug,
- discussing the current state of the code,
- submitting a fix,
- proposing new features,
- or becoming a maintainer.
As a small open source project with small community, it can sometimes take a long time to address the issues so please be patient.
Pull request process
Your pull requests are actively welcomed. We collaborate using GitHub flow.
The steps:
- Fork the repo and create your branch from master.
- If you've added code that requires testing, add tests. See tests.md.
- If you've done a major change, update the documentation. See docs/.
- Ensure the test suite passes. See development.md | Testing for commands.
- Make sure your code lints.See development.md | Linting for commands.
- Issue that pull request!
🙏 DO:
- Document why (what you're trying to solve) rather than what in the pull request.
❗ DON'T:
- Do not update the versions, current version is set by the maintainer and updated automatically by bump-everywhere.
Automated pipelines will run to control your PR and they will publish your code once the maintainer merges your PR.
📖 You can read more in ci-cd.md.
Extend scripts
Here's quick information for you who want to add more scripts.
You have two alternatives:
- Create an issue and ask for someone else to add the script for you.
- Or send a PR yourself. This would make it faster to get your code into the project. You need to add scripts to related OS in collections folder. Then you'd sent a pull request, see pull request process.
- 📖 If you're unsure about the syntax, check collection-files.md.
- 📖 If you wish to use templates, use templating.md.
License
By contributing, you agree that your GNU General Public License v3.0 will be the license for your contributions.