Skip to content

Commit 96b3788

Browse files
Docs: Updated contribution guidelines to include PR naming best practices (#20180)
* Add naming PR guide to Update contributing-creating-a-pr.md * Add PR naming guide to contributing-creating-a-pr.md * Update contributing-creating-a-pr.md * Updates note on versions and default branch Updated default branch reference and contribution guidelines. --------- Co-authored-by: Andy Butland <[email protected]>
1 parent fa575d1 commit 96b3788

File tree

1 file changed

+21
-3
lines changed

1 file changed

+21
-3
lines changed

.github/contributing-creating-a-pr.md

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,26 @@ We recommend you to [sync with our repository][sync fork] before you submit your
77
GitHub will have picked up on the new branch you've pushed and will offer to create a Pull Request. Click that green button and away you go.
88
![Create a pull request](img/createpullrequest.png)
99

10-
We like to use [git flow][git flow] as much as possible, but don't worry if you are not familiar with it. The most important thing you need to know is that when you fork the Umbraco repository, the default branch is set to `contrib`. This is the branch you should be targeting.
10+
We like to use [git flow][git flow] as much as possible, but don't worry if you are not familiar with it. The most important thing you need to know is that when you fork the Umbraco repository, the default branch is set to `main`. This is the branch you should be targeting.
1111

12-
Please note: we are no longer accepting features for v8 and below but will continue to merge security fixes as and when they arise.
12+
We welcome PRs for features and bugfixes for different versions according to the [published support and EOL schedule][support-and-eol].
13+
14+
We don't have rules for naming PRs - so name them as you prefer. At HQ we do have a best practice on clear and concise PR naming, so if you would like to use the format feel free to do so.
15+
16+
Our convention of doing it is:
17+
18+
_Area: Description (closes #IssueID)_
19+
20+
1. Start by specifying the area. Fx the feature name(UFM, Tiptap etc.) or specific section (migrations, relations, segmentation).
21+
22+
2. In your description, where applicable, mention type of PR (Build, Bump, Fix, Refactor etc.).
23+
24+
4. Good practise is to make sure you describe specifically the change and/or impact of change.<br>
25+
Example: Writing "Extension Insights: Fixes CSS alignment" instead of "Fixed issue".
26+
27+
6. Add (closes #IssueID) behind description, if your PR resolves an issue.
28+
29+
That's it!
1330

1431
## The review process
1532
[review process]: #the-review-process
@@ -48,4 +65,5 @@ There will be times that we really like your proposed changes and we’ll finish
4865

4966
[making larger changes]: contributing-before-you-start.md#making-large-changes
5067
[pr or package]: contributing-before-you-start.md#pull-request-or-package
51-
[Core collabs]: contributing-core-collabs-team.md
68+
[Core collabs]: contributing-core-collabs-team.md
69+
[support-and-eol]: https://umbraco.com/products/knowledge-center/long-term-support-and-end-of-life/

0 commit comments

Comments
 (0)