-
Notifications
You must be signed in to change notification settings - Fork 33
docs: add contributor README file #225
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.
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
+124
−0
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,124 @@ | ||
| ### Contributing | ||
|
|
||
| Thank you for your interest in contributing to this project! We welcome and | ||
| appreciate all forms of contribution—bug fixes, new features, documentation | ||
| improvements, and tests. Following these guidelines helps ensure a smooth and | ||
| efficient review process. | ||
|
|
||
| --- | ||
|
|
||
| ### Before You Start | ||
|
|
||
| 1. **Search Existing Work** | ||
| Check the repository’s [issues] and [pull requests] to see if someone is | ||
| already working on the same idea or problem. | ||
|
|
||
| 2. **Discuss Large Changes** | ||
| For major changes or new features, open an [issue] first to discuss the | ||
| design, scope, and implementation plan with the maintainers. | ||
|
|
||
| 3. **Read the Code of Conduct** | ||
| Please review and follow our [Code of Conduct](https://github.com/veraison/corim/blob/main/CODE_OF_CONDUCT.md). | ||
| We expect all contributors to maintain respectful and inclusive behavior. | ||
|
|
||
| --- | ||
|
|
||
| ### How to Contribute | ||
|
|
||
| Follow the steps below to prepare and submit your contribution: | ||
|
|
||
| ### 1. Fork & Clone | ||
|
|
||
| Start by forking the repository to your GitHub account and cloning it locally: | ||
|
|
||
| ```bash | ||
| git clone https://github.com/<your-username>/corim.git | ||
| cd corim | ||
| ``` | ||
|
|
||
| ### 2. Set Up the Project | ||
|
|
||
| Refer to the project setup instructions in the `README.md` (or the | ||
| repository's setup documentation) to install dependencies and configure your | ||
| local environment. | ||
|
|
||
| ### 3. Create a Branch | ||
|
|
||
| Create a new, descriptively named branch for your work. Use one of the | ||
| recommended prefixes: | ||
|
|
||
| `feature/` for new features. | ||
|
|
||
| `fix/` for bug fixes. | ||
|
|
||
| `chore/` for maintenance or build-related tasks. | ||
|
|
||
| ```bash | ||
| git checkout -b feature/your-feature-name | ||
| ``` | ||
|
|
||
| ### 4. Make Changes | ||
|
|
||
| **Keep it Focused:** Where possible, keep your changes focused on a single | ||
| concern. | ||
|
|
||
| **Adhere to Standards:** Follow the project's coding style and conventions. | ||
|
|
||
| **Document Code:** Keep your code well-documented and include clear inline | ||
| comments where complex logic is involved. | ||
|
|
||
| ### 5. Add or Update Tests | ||
|
|
||
| Where applicable, add tests that fully cover your changes. New or updated | ||
| tests are crucial for preventing regressions and significantly expedite the | ||
| review process. | ||
|
|
||
| ### 6. Run Tests | ||
|
|
||
| Before submitting your contribution, ensure the entire test suite passes | ||
| successfully using the project's designated test command: | ||
|
|
||
| ```bash | ||
| make test | ||
| ``` | ||
|
|
||
| ### 7. Commit Your Changes | ||
|
|
||
| Write clear, concise, and descriptive commit messages. | ||
|
|
||
| Example: | ||
|
|
||
| ```bash | ||
| git add . | ||
| git commit -m "Fix: handle null pointer in data loader (fixes #42)" | ||
| ``` | ||
|
|
||
| ### 8. Push Your Changes | ||
|
|
||
| Push your new branch to your forked repository: | ||
|
|
||
| ```bash | ||
| git push origin feature/your-feature-name | ||
| ``` | ||
|
|
||
| ### 9. Create a Pull Request (PR) | ||
|
|
||
| Open a pull request from your forked branch to the main repository's target | ||
| branch (usually main or master). | ||
|
|
||
| **Detailed Description:** Include a comprehensive description of your changes, | ||
| the rationale behind them, and any relevant issue numbers (e.g., Closes #101). | ||
|
|
||
| **Checklist:** Consider including a small checklist in your PR description | ||
| (e.g., tests added/updated, documentation updated, code style checked). | ||
yogeshbdeshpande marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ### 10. Prior to Merge | ||
|
|
||
| Ensure all CI tests pass | ||
|
|
||
| Ensure the Pull Request is reviewed by at least two maintainers of the project. | ||
|
|
||
| Incorporate all the review comments. In case of conflicting comments, | ||
| please schedule a meeting and coordinate among all reviewers to reach a consensus. | ||
|
|
||
| Then only request maintainers to Merge the Pull Request | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.