Skip to content

Commit

Permalink
README.md: Rough move to new contribution doc files
Browse files Browse the repository at this point in the history
No content was changed, new titles are wrapped with () to signal that
they will need to be decided on in a future commit.
  • Loading branch information
infinisil committed Aug 13, 2023
1 parent d70091c commit b98abe5
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 20 deletions.
23 changes: 23 additions & 0 deletions CONTRIBUTING-new.md
Original file line number Diff line number Diff line change
@@ -1 +1,24 @@
# Contributing to Nixpkgs

## (Proposing a change)

When pull requests are made, our tooling automation bot,
[OfBorg](https://github.com/NixOS/ofborg) will perform various checks
to help ensure expression quality.

## (Merging a pull request)

The *Nixpkgs committers* are people who have been given
permission to merge.

## (Flow of changes)

Most contributions are based on and merged into these branches:

* `master` is the main branch where all small contributions go
* `staging` is branched from master, changes that have a big impact on
Hydra builds go to this branch
* `staging-next` is branched from staging and only fixes to stabilize
and security fixes with a big impact on Hydra builds should be
contributed to this branch. This branch is merged into master when
deemed of sufficiently high quality
21 changes: 1 addition & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,26 +70,7 @@ Linux distribution. The [GitHub Insights](https://github.com/NixOS/nixpkgs/pulse
page gives a sense of the project activity.

Community contributions are always welcome through GitHub Issues and
Pull Requests. When pull requests are made, our tooling automation bot,
[OfBorg](https://github.com/NixOS/ofborg) will perform various checks
to help ensure expression quality.

The *Nixpkgs maintainers* are people who have assigned themselves to
maintain specific individual packages. We encourage people who care
about a package to assign themselves as a maintainer. When a pull
request is made against a package, OfBorg will notify the appropriate
maintainer(s). The *Nixpkgs committers* are people who have been given
permission to merge.

Most contributions are based on and merged into these branches:

* `master` is the main branch where all small contributions go
* `staging` is branched from master, changes that have a big impact on
Hydra builds go to this branch
* `staging-next` is branched from staging and only fixes to stabilize
and security fixes with a big impact on Hydra builds should be
contributed to this branch. This branch is merged into master when
deemed of sufficiently high quality
Pull Requests.

For more information about contributing to the project, please visit
the [contributing page](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md).
Expand Down
6 changes: 6 additions & 0 deletions maintainers/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,7 @@
# Nixpkgs Maintainers

The *Nixpkgs maintainers* are people who have assigned themselves to
maintain specific individual packages. We encourage people who care
about a package to assign themselves as a maintainer. When a pull
request is made against a package, OfBorg will notify the appropriate
maintainer(s).

0 comments on commit b98abe5

Please sign in to comment.