Skip to content

Commit

Permalink
Fix the link to guidance on development flow
Browse files Browse the repository at this point in the history
The linked Confluence pages give me a 404. Searching Confluence for
"development flow" 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/swCYEg
  • Loading branch information
lawrence-forooghian committed May 29, 2024
1 parent e090584 commit ff814a4
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions best-practices/pull-requests.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ In order for a PR to be merged, everyone who has been tagged as a reviewer must

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.
The use of branches generally should follow the policy for [development flow](development-flow.md). 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.

Individual changes that impact a very large number of files (for example bulk application of a code style change, or renaming a widely used identifier) should be made as separate commits (or ideally separate PRs).

Expand Down Expand Up @@ -100,7 +100,7 @@ Feedback and associated changes must be conducted to the satisfaction of the rev

## Merging PRs

By default the author is expected to merge a PR once it is approved. Whether this is by merge or rebase is subject to considerations relating to the overall [flow and branching policy](https://ably.atlassian.net/wiki/Development-flow-for-Ably-repos).
By default the author is expected to merge a PR once it is approved. Whether this is by merge or rebase is subject to considerations relating to the overall [flow and branching policy](development-flow.md).

For certain repos - especially where there is a very broad scope, and contributions by multiple teams - it might be necessary that a maintainer, rather than the author, determines the order in which PRs are landed. It is the responsibility of the maintainers of those repos to define the policy for merging in such cases.

Expand Down

0 comments on commit ff814a4

Please sign in to comment.