From c6127abd62beda8a35bb29a1bc892cef0d52c375 Mon Sep 17 00:00:00 2001 From: Tusharjamdade Date: Sat, 27 Sep 2025 21:56:09 +0530 Subject: [PATCH 1/4] docs: add contributor README file --- CONTRIBUTING.md | 86 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 86 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..31f2afc4 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,86 @@ +### 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//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). \ No newline at end of file From c1167dcbff87a394271db20796668298f5036d6f Mon Sep 17 00:00:00 2001 From: Tusharjamdade Date: Thu, 2 Oct 2025 19:40:49 +0530 Subject: [PATCH 2/4] fix: wrap long lines --- CONTRIBUTING.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 31f2afc4..ad703ac7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,9 @@ ### 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. +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. --- From 76e639b0aab17a8858a1ffa001f640964c6a8ae1 Mon Sep 17 00:00:00 2001 From: Tusharjamdade Date: Thu, 2 Oct 2025 19:43:04 +0530 Subject: [PATCH 3/4] fix: wrap long lines --- CONTRIBUTING.md | 50 ++++++++++++++++++++++++++++++++++++------------- 1 file changed, 37 insertions(+), 13 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ad703ac7..3c36f3b6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,20 +10,25 @@ 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. + 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. + 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. + 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 @@ -32,10 +37,15 @@ 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. + +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: + +Create a new, descriptively named branch for your work. Use one of the +recommended prefixes: `feature/` for new features. @@ -48,23 +58,32 @@ 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. +**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. +**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. + +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: + +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: @@ -75,6 +94,7 @@ 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 @@ -82,8 +102,12 @@ 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). +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). \ No newline at end of file +**Checklist:** Consider including a small checklist in your PR description +(e.g., tests added/updated, documentation updated, code style checked). From 02af298fa21fe9ce14220258afbc26a2a777d11d Mon Sep 17 00:00:00 2001 From: Yogesh Deshpande Date: Thu, 9 Oct 2025 14:25:12 +0100 Subject: [PATCH 4/4] Update CONTRIBUTING.md --- CONTRIBUTING.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3c36f3b6..303e222a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -111,3 +111,14 @@ 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). + +### 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