From 1366d84ca8f12fc80c1fedc2d0616d408a694420 Mon Sep 17 00:00:00 2001 From: Blake Li Date: Wed, 27 Sep 2023 13:14:19 -0400 Subject: [PATCH 1/2] docs: Add contribution guidelines. --- CONTRIBUTING.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 22b241cb73..d2b96ce1d0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,7 +1,11 @@ # How to Contribute -We'd love to accept your patches and contributions to this project. There are -just a few small guidelines you need to follow. +We'd love to accept your patches and contributions to this project. There are just a few small guidelines you need to follow before opening an issue or a PR: +1. Ensure the issue was not already reported. +2. Open a new issue if you are unable to find an existing issue addressing your problem. Make sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring. +3. Discuss the priority and potential solutions with the maintainers. +4. Open a PR only if the priority and the solution is being agreed by the maintainers, ensure the PR description clearly describes the problem and solution. Note that an open PR without an open issue or without discussing with the maintainers will not be accepted. + ## Contributor License Agreement From cf31660a43dfd6dc8dd263d6485e74cb2b305976 Mon Sep 17 00:00:00 2001 From: Lawrence Qiu Date: Thu, 15 Feb 2024 15:52:30 -0500 Subject: [PATCH 2/2] chore: Update CONTRIBUTING.md --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d2b96ce1d0..f2b357f2ab 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,8 +3,8 @@ We'd love to accept your patches and contributions to this project. There are just a few small guidelines you need to follow before opening an issue or a PR: 1. Ensure the issue was not already reported. 2. Open a new issue if you are unable to find an existing issue addressing your problem. Make sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring. -3. Discuss the priority and potential solutions with the maintainers. -4. Open a PR only if the priority and the solution is being agreed by the maintainers, ensure the PR description clearly describes the problem and solution. Note that an open PR without an open issue or without discussing with the maintainers will not be accepted. +3. Discuss the priority and potential solutions with the maintainers in the issue. The maintainers would review the issue and add a label "Accepting Contributions" once the issue is ready for accepting contributions. +4. Open a PR only if the issue is labeled with "Accepting Contributions", ensure the PR description clearly describes the problem and solution. Note that an open PR without an issue labeled with "Accepting Contributions" will not be accepted. ## Contributor License Agreement