tym83
34c8d7873c
The DCO requirement was only stated in agent-facing guidance, so a first-time contributor learned about it from a failing check. CONTRIBUTING.md now explains the sign-off and how to fix a missing one. DCO and CodeQL become required status checks on main, so the security documents no longer describe them as gates by review convention. Assisted-by: LLM Signed-off-by: tym83 <6355522@gmail.com>
3.8 KiB
Contributing to Cozystack
Welcome! We are glad that you want to contribute to our Cozystack project! 💖
As you get started, you are in the best position to give us feedbacks on areas of our project that we need help with, including:
- Problems found while setting up the development environment
- Gaps in our documentation
- Bugs in our GitHub actions
First, though, it is important that you read the CNCF Code of Conduct.
The guidelines below are a starting point. We don't want to limit your creativity, passion, and initiative. If you think there's a better way, please feel free to bring it up in a GitHub discussion, or open a pull request. We're certain there are always better ways to do things, we just need to start some constructive dialogue!
Ways to contribute
We welcome many types of contributions including:
- New features
- Builds, CI/CD
- Bug fixes
- Documentation
- Issue Triage
- Answering questions on Slack or GitHub Discussions
- Web design
- Communications / Social Media / Blog Posts
- Events participation
- Release management
Ask for Help
The best way to reach us with a question when contributing is to drop a line in our Telegram channel, or start a new GitHub discussion.
Where do I file?
Cozystack work is split across two repositories. Use this table to land in the right place:
| You have… | Where it goes |
|---|---|
| A bug | New issue → Bug report in this repo (kind/bug) |
| A concrete, scoped feature | New issue → Feature request in this repo (kind/feature) |
| A usage question or an early idea | GitHub Discussions |
| A cross-cutting / architectural change — affects multiple components or APIs, or needs a decision before code | A design proposal in the community repo |
| Governance, process, or community matters | The community repo |
Rule of thumb: bugs and concrete features live here; "what or whether we should build it" lives in community as a design proposal or discussion. A large feature often starts as a Discussion, graduates to a design-proposal PR, then spawns implementation issues here.
Raising Issues
When raising issues, please specify the following:
- A scenario where the issue occurred (with details on how to reproduce it)
- Errors and log messages that are displayed by the involved software
- Any other detail that might be useful
Sign Off Your Commits (DCO)
Cozystack uses the Developer Certificate of Origin (DCO) instead of a contributor licence agreement. By signing off a commit, you certify that you wrote the change or otherwise have the right to submit it under the project's open source licence.
Every commit in a pull request must carry a Signed-off-by trailer whose name and email match the commit author. Git adds it for you with --signoff (or -s):
git commit --signoff -m "fix(postgres): read the live Cluster when deciding the WAL-archive prefix"
If you forgot, add the sign-off to the last commit with git commit --amend --signoff, or to every commit on your branch with git rebase --signoff main, then force-push the branch.
The DCO check verifies this on every pull request and is required to pass before a pull request can be merged into main, together with pre-commit, E2E Tests and CodeQL.