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

Contributing branches and reverting #9577

Merged

Conversation

roberth
Copy link
Member

@roberth roberth commented Dec 10, 2023

Motivation

  • Explain our branches
  • Explain why reverts are good

I consider the latter crucial for agility.

Let's review this in a meeting.

Context

Priorities

Add 👍 to pull requests you find important.

@roberth roberth added documentation contributor-experience Developer experience for Nix contributors process Issues related to the development process of Nix labels Dec 10, 2023
Copy link
Member

@Ericson2314 Ericson2314 left a comment

Choose a reason for hiding this comment

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

I first learned of this revert style from LLVM. It surprised me at first, but then I came to believe it is good.

Copy link
Contributor

@fricklerhandwerk fricklerhandwerk left a comment

Choose a reason for hiding this comment

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

Thank you, this is important.

doc/manual/src/contributing/hacking.md Outdated Show resolved Hide resolved
doc/manual/src/contributing/hacking.md Outdated Show resolved Hide resolved
Comment on lines 314 to 316
- _other_

Branches that do not conform to the above patterns should be feature branches.
Copy link
Contributor

Choose a reason for hiding this comment

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

IMHO those should not exist at all, and feature branches should come from forks. Since this documentation is descriptive rather than prescriptive, I won't block that with my desire to discuss this, but I'd still like to discuss it eventually.

Copy link
Member Author

Choose a reason for hiding this comment

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

Forks in organizations are problematic because they can't be configured to allow contributions from upstream maintainers. We might suggest using personal forks.

Copy link
Member

Choose a reason for hiding this comment

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

I also tend to use feature branches from the NixOS repo because it's the only sane way for having stacked PRs in GitHub (although that's a bit of an edge-case)

Copy link
Member Author

Choose a reason for hiding this comment

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

Fwiw this makes no claim about the lifecycle of the feature branch. Any branch that isn't a maintenance branch or - I guess - a proof of concept should be short-lived.
I don't think we should focus any attention on these branches for the time being, while we have bigger fish to fry, such as the again increasing PR queue, and stabilization.

doc/manual/src/contributing/hacking.md Outdated Show resolved Hide resolved
doc/manual/src/contributing/hacking.md Outdated Show resolved Hide resolved
doc/manual/src/contributing/hacking.md Outdated Show resolved Hide resolved
roberth and others added 2 commits December 11, 2023 11:46
Co-authored-by: Valentin Gagarin <[email protected]>
The GitHub search is not fantastic but gets the job done.
@fricklerhandwerk fricklerhandwerk merged commit 89cf536 into NixOS:master Dec 11, 2023
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contributor-experience Developer experience for Nix contributors documentation process Issues related to the development process of Nix
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

4 participants