Skip to content

chore: add org-level CONTRIBUTING.md #105

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
shenxianpeng merged 1 commit into from
Jul 8, 2026
Merged

chore: add org-level CONTRIBUTING.md #105

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.

@2bndy5 2bndy5 Jul 8, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This may not be necessary. To my knowledge, the only project that uses changelogs is cpp-linter-rs, and those changelogs are auto-generated when a new version is deployed.

@shenxianpeng shenxianpeng Jul 8, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Another one use changelog is here https://github.com/cpp-linter/asdf-clang-tools/blob/main/CHANGELOG.md

@shenxianpeng shenxianpeng Jul 8, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It used https://github.com/googleapis/release-please to generate the changelog

- **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.