From 7f97bd1ea7d574bd45068ec51e5de6a693c650b6 Mon Sep 17 00:00:00 2001 From: Tomo Suzuki Date: Fri, 16 Feb 2024 13:24:09 -0500 Subject: [PATCH] chore: updating CONTRIBUTING.md (#2434) * chore: updating CONTRIBUTING.md Updating CONTRIBUTING.md as per go/java-repos-contrib-guidelines b/323273913 * owlbot.py to exclude CONTRIBUTING.md --- CONTRIBUTING.md | 9 ++++++--- owlbot.py | 1 + 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b65dd279c..ee2c5ce00 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,7 +1,10 @@ # 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. +Please follow the guidelines below 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 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 issues labeled with "Accepting Contributions" will not be accepted. ## Contributor License Agreement @@ -89,4 +92,4 @@ mvn com.coveo:fmt-maven-plugin:format [1]: https://cloud.google.com/docs/authentication/getting-started#creating_a_service_account [2]: https://maven.apache.org/settings.html#Active_Profiles -[3]: https://github.com/GoogleCloudPlatform/java-docs-samples/blob/main/SAMPLE_FORMAT.md \ No newline at end of file +[3]: https://github.com/GoogleCloudPlatform/java-docs-samples/blob/main/SAMPLE_FORMAT.md diff --git a/owlbot.py b/owlbot.py index d6da82cca..1e97fea99 100644 --- a/owlbot.py +++ b/owlbot.py @@ -24,6 +24,7 @@ java.common_templates( excludes=[ "README.md", + "CONTRIBUTING.md", "java.header", "checkstyle.xml", "renovate.json",