You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+14Lines changed: 14 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -26,6 +26,7 @@ All types of contributions are encouraged and valued. See the [Table of Contents
26
26
-[Improving The Documentation](#improving-the-documentation)
27
27
-[Code Style](#code-style)
28
28
-[Commit Messages](#commit-messages)
29
+
-[Change Review Process](#change-review-process)
29
30
-[Join The Project Team](#join-the-project-team)
30
31
31
32
@@ -241,5 +242,18 @@ Grails code style mostly mirrors the Spring Framework's [Style Guide](https://gi
241
242
### Commit Messages
242
243
Grails makes use of [Release Drafter](https://github.com/release-drafter/release-drafter) to draft its release notes so commit messages are important. They should follow the project's rules. While a change can be incrementally made under many commits, pull requests should be squashed into a single, meaningful commit message.
243
244
245
+
### Change Review Process
246
+
The Grails project uses different review processes based on the change being made. We use both a `Review then Commit` policy and a `Commit then Review` policy. These policies only apply to what we consider `protected` branches - where a `protected` branch is a branch that will result in published code or tracks a Grails release version (i.e. 7.0.x is for the Grails 7 release). Development will often occur in side branches without review and the review will be performed at the time of merging those changes into a `protected` branch.
247
+
248
+
Concerning when a review is required for a `protected` branch:
249
+
* Build Related Changes - `Commit then Review`
250
+
* Due to the build changes being related to GitHub workflows and not being able to test locally.
251
+
* Documentation Changes - obvious fixes should be allowed without review, otherwise only minimum 1 reviewer with `Commit then Review`
252
+
* Groovy or Spring Dependency Changes - `Review then Commit` and mandated waiting period
253
+
* Reasoning: due to the impact of past Spring & Groovy upgrades, it often breaks the entire development chain. These changes should not be merged without significant review.
254
+
* Minimum # of Reviewers: 2 reviewers, preferred 3
255
+
* Mandated Waiting Period: 3 days if over a weekend, 1 day if during the week.
256
+
* Otherwise - `Review then Commit` with only 1 reviewer required.
257
+
244
258
## Join The Project Team
245
259
For people willing to contribute more than an occasional pull request, consider joining our core team. Inquire in the `questions` channel in slack to learn more.
0 commit comments