Skip to content

Commit

Permalink
docs: Add contribution guidelines (#2771)
Browse files Browse the repository at this point in the history
* docs: Add contribution guidelines

* docs: update issue and PR templates with contribution guidelines
  • Loading branch information
burkedavison committed Apr 23, 2024
1 parent 67d994e commit add0da7
Show file tree
Hide file tree
Showing 4 changed files with 57 additions and 3 deletions.
19 changes: 18 additions & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,27 @@ labels: waiting-for-triage
assignees: ''

---
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 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.

See
also [CONTRIBUTING.md](https://github.com/GoogleCloudPlatform/spring-cloud-gcp/blob/main/CONTRIBUTING.md)
.

**Describe the bug**
Please provide details of the problem, including the version of Spring Cloud that you
are using.
are using.

**Sample**
If possible, please provide a test case or sample application that reproduces
Expand Down
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,23 @@ labels: waiting-for-triage
assignees: ''

---
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 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.

See
also [CONTRIBUTING.md](https://github.com/GoogleCloudPlatform/spring-cloud-gcp/blob/main/CONTRIBUTING.md)
.

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is and what version of Spring Cloud you are using. Ex. I'm always frustrated when [...]
Expand Down
17 changes: 17 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
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 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.

See
also [CONTRIBUTING.md](https://github.com/GoogleCloudPlatform/spring-cloud-gcp/blob/main/CONTRIBUTING.md)
.
7 changes: 5 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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.
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 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

Expand Down

0 comments on commit add0da7

Please sign in to comment.