Skip to content

Commit a7f473b

Browse files
Add a PR template with guidelines
1 parent 09513ca commit a7f473b

1 file changed

Lines changed: 24 additions & 0 deletions

File tree

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,27 @@
1+
# For SonarSourcers:
2+
3+
- [ ] Create a [JIRA](http://jira.sonarsource.com/browse/PLUGINAPI) ticket if the API is impacted
4+
- [ ] Prefix the commit message with the ticket number
5+
- [ ] Document the change in CHANGELOG.md
6+
- [ ] When adding a new API:
7+
- [ ] Explain in the JavaDoc the purpose of the new API
8+
- [ ] Add a `@since X.Y` in the JavaDoc
9+
- [ ] When deprecating an API:
10+
- [ ] Annotate the deprecated element with `@Deprecated`
11+
- [ ] Add a `@deprecated since X.Y` in the JavaDoc
12+
- [ ] Document the replacement in the JavaDoc (if any)
13+
- [ ] When dropping an API:
14+
- [ ] Make sure it respects the [deprecation policy](../docs/deprecation-policy.md)
15+
- [ ] Bump the major version (breaking change)
16+
- [ ] Make sure checks are green: build passes, Quality Gate is green
17+
- [ ] Merge after getting approval by at least one member of the guild
18+
- If no review is made within 3 days, gently ping the reviewers
19+
- The guild member reviewing the code can explicitly request someone else (typically another guild member representing another team) to check the impact on the specific product
20+
- In some cases, the guild may deem it necessary that multiple or even all members approve a PR. This is more likely in complex changes or changes directly impacting all teams using the API.
21+
22+
23+
# For external contributors:
24+
125
Please be aware that we are not actively looking for feature contributions. The truth is that it's extremely difficult for someone outside SonarSource to comply with our roadmap and expectations. Therefore, we typically only accept minor cosmetic changes and typo fixes. If you would like to see a new feature, please create a new thread in the forum "Suggest new features".
226

327
With that in mind, if you would like to submit a code contribution, make sure that you adhere to the following guidelines and all tests are passing:

0 commit comments

Comments
 (0)