Skip to content

Commit a0737e4

Browse files
Create CONTRIBUTING.md for contribution guidelines
Added a comprehensive contributing guide to assist new contributors with the process and expectations.
1 parent a8df1e0 commit a0737e4

File tree

1 file changed

+86
-0
lines changed

1 file changed

+86
-0
lines changed

CONTRIBUTING.md

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
# Contributing
2+
3+
Thank you for your interest in contributing! This document explains how collaborators and contributors can work with this repository to make meaningful, consistent contributions.
4+
5+
## Table of Contents
6+
- Welcome
7+
- Code of Conduct
8+
- Getting started
9+
- Reporting issues
10+
- Proposing changes (Pull Requests)
11+
- Branching and commit conventions
12+
- Coding style and tests
13+
- Review process
14+
- Communication & support
15+
- Onboarding new collaborators
16+
- License & copyright
17+
18+
## Welcome
19+
We welcome contributions of all kinds: bug reports, documentation improvements, tests, examples, and code changes. If you're unsure where to start, look for issues labeled `good first issue` or `help wanted`, or say hello in the project's communication channels.
20+
21+
## Code of Conduct
22+
All contributors are expected to follow our Code of Conduct. Be respectful and professional in all interactions. If a Code of Conduct file exists in the repository, please read it; if not, maintain a friendly and inclusive tone.
23+
24+
## Getting started
25+
1. Fork the repository (if applicable) and clone your fork:
26+
git clone https://github.com/<your-username>/<repo>.git
27+
2. Create a local branch for your work:
28+
git checkout -b feat/short-description or bugfix/short-description
29+
3. Install dependencies and run the test suite:
30+
- Follow the instructions in README.md for local setup
31+
- Run tests: (e.g., npm test, pytest, or other commands specified in README)
32+
33+
## Reporting issues
34+
- Search existing issues before creating a new one.
35+
- Be descriptive: include steps to reproduce, expected vs actual behavior, environment (OS, versions), and logs or screenshots where helpful.
36+
- Use labels and templates if the repository provides them.
37+
38+
## Proposing changes (Pull Requests)
39+
- Create a descriptive branch name (see Branching below).
40+
- Make small, focused changes with clear commit messages.
41+
- Open a pull request against the repository's main branch (or the branch indicated by maintainers).
42+
- In your PR description, include:
43+
- What problem the change solves
44+
- A short summary of the changes
45+
- Any relevant issue numbers (e.g., fixes #123)
46+
- How to test the change locally
47+
- Link to any related issues and add relevant labels if you can.
48+
49+
## Branching and commit conventions
50+
- Branch naming examples:
51+
- feat/<short-description>
52+
- fix/<short-description>
53+
- docs/<short-description>
54+
- chore/<short-description>
55+
- Commit messages should be concise and follow this pattern:
56+
- <type>(scope): Short summary
57+
- Body (optional): More detailed explanation, why the change was needed, and any notes about migration or backward compatibility.
58+
- Example: feat(api): add user search endpoint
59+
60+
## Coding style and tests
61+
- Follow the project's existing style and linting rules. Run linter locally before submitting.
62+
- Add tests for new features and bug fixes. Ensure all tests pass.
63+
- If the project uses CI (e.g., GitHub Actions), your PR should pass all checks before merging.
64+
65+
## Review process
66+
- PRs will be reviewed by maintainers and other collaborators.
67+
- Expect feedback and requested changes — respond promptly and iterate.
68+
- When approved, a maintainer may merge the PR, squash commits, or request a rebase.
69+
70+
## Communication & support
71+
- Use the project's preferred channels (issues, discussions, Slack/Discord, etc.) for questions.
72+
- Be patient: maintainers are often volunteers and may need time to respond.
73+
74+
## Onboarding new collaborators
75+
- If you are joining as a repository collaborator:
76+
- Introduce yourself and let maintainers know which areas you want to help with.
77+
- We may assign a mentor or point you to starter tasks.
78+
- Adhere to the same review and merge policies as other contributors.
79+
80+
## License & copyright
81+
- Contributions are made under the repository's license. By contributing, you agree to license your contributions under the same terms.
82+
- If you have IP concerns, raise them privately with repository maintainers before submitting code.
83+
84+
---
85+
86+
If something here is unclear or you'd like a custom contributing guide (with templates, checklists, or CI details), tell us the repository name and any project conventions and I'll adapt this file to match.

0 commit comments

Comments
 (0)