Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(chained_prs): add description on chained PRs #70

Merged
merged 2 commits into from
Dec 6, 2023
Merged

Conversation

danielRep
Copy link
Member

PR Description

This PR introduces to the contributing guidelines a description on when and why to use a chain of PRs.

Type of change

  • feat: introduces a new functionality
    • Logical unit: <contributing.rst>

Checklist:

  • The changes follows the documentation guidelines described in here.
  • The changes generate no new warnings when building the project. If so, I have justified above.
  • I have run the CI checkers before submitting the PR to avoid unnecessary runs of the workflow.

@danielRep danielRep requested a review from josecm as a code owner October 8, 2023 15:27
@danielRep danielRep force-pushed the feat/chained_prs branch 2 times, most recently from ba9e8cd to 9b3e4a4 Compare October 8, 2023 15:37
@josecm josecm self-assigned this Oct 26, 2023
Copy link
Member

@josecm josecm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This part of the documentation needs to differentiate between two topics in development:

  • Chained PRs themselves that are a way to issue multiple PRs, on which one PRs depends on the other.
  • WIP branches development process, which is a way to, for a large contribution, provide separate PRs that are reviews and merged separately for a temporary WIP branch, and that will later be merged to main based on a separate PR.

As an alternative, you could issue separate PRs for each one.

@danielRep danielRep force-pushed the feat/chained_prs branch 5 times, most recently from 7f17ed6 to a7a9136 Compare October 27, 2023 17:17
@danielRep
Copy link
Member Author

This part of the documentation needs to differentiate between two topics in development:

  • Chained PRs themselves that are a way to issue multiple PRs, on which one PRs depends on the other.
  • WIP branches development process, which is a way to, for a large contribution, provide separate PRs that are reviews and merged separately for a temporary WIP branch, and that will later be merged to main based on a separate PR.

As an alternative, you could issue separate PRs for each one.

I just self-contained this PR on the description of chain of PRs and created a new one #73 to explain the process of splitting large PRs.

source/development/contributing.rst Outdated Show resolved Hide resolved
source/development/contributing.rst Outdated Show resolved Hide resolved
source/development/contributing.rst Outdated Show resolved Hide resolved
source/development/contributing.rst Outdated Show resolved Hide resolved
source/development/contributing.rst Outdated Show resolved Hide resolved
source/development/contributing.rst Outdated Show resolved Hide resolved
source/development/contributing.rst Show resolved Hide resolved
source/development/contributing.rst Outdated Show resolved Hide resolved
@danielRep danielRep force-pushed the feat/chained_prs branch 3 times, most recently from 23be74c to f80547a Compare December 5, 2023 13:26
josecm
josecm previously approved these changes Dec 5, 2023
@DavidMCerdeira DavidMCerdeira self-requested a review December 5, 2023 20:08
@DavidMCerdeira
Copy link
Member

Please rebase the branch with main

@danielRep danielRep dismissed josecm’s stale review December 6, 2023 11:04

The merge-base changed after approval.

@danielRep danielRep force-pushed the feat/chained_prs branch 3 times, most recently from b68d958 to 4b66440 Compare December 6, 2023 11:26
Signed-off-by: Daniel Oliveira <drawnpoetry@gmail.com>
@danielRep
Copy link
Member Author

Please rebase the branch with main

Done.

@DavidMCerdeira DavidMCerdeira self-requested a review December 6, 2023 14:34
@josecm josecm merged commit cf60185 into main Dec 6, 2023
4 checks passed
@josecm josecm deleted the feat/chained_prs branch December 6, 2023 20:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants