Skip to content

Commit

Permalink
Fix the link to guidance on how to do Git commits
Browse files Browse the repository at this point in the history
The linked Confluence page gives me a 404. Searching Confluence for "Git
commit" gives me [1], which suggests that the canonical source for this
data is actually the guidance that was added to this repo in ef8ac8f.

[1] https://ably.atlassian.net/wiki/x/eoChEg
  • Loading branch information
lawrence-forooghian committed May 28, 2024
1 parent 33da110 commit a4a2d52
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion best-practices/pull-requests.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ In order for a PR to be merged, everyone who has been tagged as a reviewer must

## PR scope and structure

The scope and structure for a PR should be based on the guiding principles that apply to [commit and history structure](https://ably.atlassian.net/l/c/7QP1L31X): PRs should ideally cover a self-contained set of changes, with an overall scope that is large enough that the overall intent of the changes is clear, and small enough that it is manageable to be reviewed in detail. PRs that are too large tend to result in reviews that are more superficial and less effective.
The scope and structure for a PR should be based on the guiding principles that apply to [commit and history structure](commits.md): PRs should ideally cover a self-contained set of changes, with an overall scope that is large enough that the overall intent of the changes is clear, and small enough that it is manageable to be reviewed in detail. PRs that are too large tend to result in reviews that are more superficial and less effective.

The use of branches generally should follow the policy for [development flow](https://ably.atlassian.net/wiki/spaces/PUB/pages/803766520). If the changes being made are necessarily extensive, then the preferred way to structure the work is as a series of PRs made against an integration branch, so each individual PR remains a manageable size.

Expand Down

0 comments on commit a4a2d52

Please sign in to comment.