From 0de3d6add8f09d85f33335a9e4d2bf84ebcaf088 Mon Sep 17 00:00:00 2001 From: shenxianpeng Date: Thu, 9 Jul 2026 01:03:10 +0300 Subject: [PATCH] chore: add org-level CONTRIBUTING.md Lightweight contributing guide covering getting started, branch target, commit conventions (Conventional Commits), PR process, and links to per-repo guides. --- CONTRIBUTING.md | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..8e464fd --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,41 @@ +# Contributing + +Thank you for investing your time in contributing to a cpp-linter project! + +## Getting Started + +1. **Choose a repo** — Browse our [repositories](https://github.com/orgs/cpp-linter/repositories) and find the one you'd like to contribute to. +2. **Read its CONTRIBUTING.md** — Each repo may have its own contribution guide with project-specific instructions. +3. **Check open issues** — Look for issues labeled `help wanted` or `good first issue`. + +## General Guidelines + +- **Branch**: All PRs should target the `main` branch. +- **Changelog**: If the project uses a changelog, add an entry describing your change. +- **Tests**: Add tests for new features and bug fixes where applicable. +- **Documentation**: Update docs if your change affects user-facing behavior. + +## Commit Style + +We recommend using [Conventional Commits](https://www.conventionalcommits.org/): + +- `feat:` — new feature +- `fix:` — bug fix +- `chore:` — maintenance, config, dependencies +- `docs:` — documentation only +- `refactor:` — code restructuring without feature or fix + +## Pull Request Process + +1. Fork the repository and create a feature branch. +2. Make your changes, keeping them focused and granular. +3. Push your branch and open a PR against `main`. +4. Keep PRs small — separate unrelated changes into different PRs. + +## Code of Conduct + +All contributions are subject to our [Code of Conduct](CODE_OF_CONDUCT.md). + +## License + +By contributing, you agree that your contributions will be licensed under the same license as the project you're contributing to.