Skip to content

Commit

Permalink
fixing typos
Browse files Browse the repository at this point in the history
  • Loading branch information
@mrVanDalo
mrVanDalo committed Sep 30, 2019
1 parent 3682c00 commit a3be8dc
Show file tree
Hide file tree
Showing 5 changed files with 44 additions and 44 deletions.
42 changes: 21 additions & 21 deletions rfcs/0053-pull-request-workflow.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ related-issues:
# Summary
[summary]: #summary

Pull-Request on GitHub are the main way we improve our code base.
This Document should settle everything that needs to be done
Pull request on GitHub are the main way we improve our code base.
This document should settle everything that needs to be done
to bring code upstream in the
[Nixpkgs Repository](https://github.com/nixos/nixpkgs/).

Expand All @@ -27,7 +27,7 @@ on how we do it now.
# Detailed design
[design]: #detailed-design

Define all steps of a Pull-Request.
Define all steps of a Pull request.
Use Roles to define responsibilities in every step.

Terms like **SHOULD** and **MUST** are defined in
Expand All @@ -39,18 +39,18 @@ Terms like **SHOULD** and **MUST** are defined in
Everybody involved in the process of contributing has one or multiple
of the following roles

* `Contributor` is the person proposing the Pull-Request
* `Contributor` is the person proposing the Pull request
* `Bot` is a bot that provides automated feedback
* `Reviewer` is any person that reviews the Pull-Request
* `Reviewer` is any person that reviews the Pull request
(for example a member of [NixOS/nixpkgs-maintainers](https://github.com/orgs/NixOS/teams/nixpkgs-maintainers))
* `Merger` is any person with merge privileges

The responsibilities of theses roles are defined in the rest of this RFC.

## States of a Pull-Request
## States of a Pull request
[state]:#states

This diagram defines all states of a Pull-Request,
This diagram defines all states of a Pull request,
and their transitions to other states.

![pull-request state](0053-pull-request-workflow/pull-request-states.svg)
Expand All @@ -62,28 +62,28 @@ The responsibilities of every role is defined by the following diagram:

![pull-request activity](0053-pull-request-workflow/pull-request-roles.svg)

## About Pull-Requests
## About Pull requests

### Packages

* contributors **SHOULD** evaluate and signal that a Backport is necessary.
* the [NixOS/backports team](https://github.com/orgs/NixOS/teams/backports)
* Contributors **SHOULD** evaluate and signal that a backport is necessary.
* The [NixOS/backports team](https://github.com/orgs/NixOS/teams/backports)
**SHOULD** be pinged in situations that are unclear.
* the [NixOS/backports team](https://github.com/orgs/NixOS/teams/backports)
**MUST** be informed about every Backport.
* after the Pull-Request to `master`, `staging` or `staging-next` is merged,
the Backport Pull-Request is created
* Backport Pull-Requests **MUST** be linked to the original Pull-Requests (using `git cherry-pick -x`).
* The [NixOS/backports team](https://github.com/orgs/NixOS/teams/backports)
**MUST** be informed about every backport.
* After the Pull request to `master`, `staging` or `staging-next` is merged,
the backport Pull request is created
* Backport Pull requests **MUST** be linked to the original Pull requests (using `git cherry-pick -x`).
* [NixOS/nixpkgs-maintainers](https://github.com/orgs/NixOS/teams/nixpkgs-maintainers)
and
[NixOS/backports](https://github.com/orgs/NixOS/teams/backports)
can deny the backport.

### Modules

* modules **SHOULD** have tests
* reviewers **SHOULD** encourage contributors to write tests for new modules
* modules **SHOULD NOT** be Backported
* Modules **SHOULD** have tests
* Reviewers **SHOULD** encourage contributors to write tests for new modules
* Modules **SHOULD NOT** be backported

## Links

Expand All @@ -93,15 +93,15 @@ The responsibilities of every role is defined by the following diagram:
# Unresolved questions
[unresolved]: #unresolved-questions

* The Pull-Request of a Backport should be created by the bot.
* The Pull request of a backport should be created by the bot.
But if that is the case, the original contributor might not be able
to make changes on the branch behind the Pull-Request.
to make changes on the branch behind the Pull request.
* Backports without changes in `master` are not discussed.
for example security patches that only affect older versions in stable.

# Future work
[future]: #future-work

* The Pull-Request template needs an option "Backport needed?"
* The Pull request template needs an option "backport needed?"
* Add a link to this document in the
[Contribution Guidelines](https://github.com/NixOS/nixpkgs/blob/master/.github/CONTRIBUTING.md)
12 changes: 6 additions & 6 deletions rfcs/0053-pull-request-workflow/pull-request-roles.graphml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@
<y:Geometry height="31.0" width="131.0" x="123.89999999999993" y="155.0"/>
<y:Fill color="#FFCC00" transparent="false"/>
<y:BorderStyle color="#000000" raised="false" type="line" width="1.0"/>
<y:NodeLabel alignment="center" autoSizePolicy="content" fontFamily="Dialog" fontSize="12" fontStyle="plain" hasBackgroundColor="false" hasLineColor="false" height="17.96875" horizontalTextPosition="center" iconTextGap="4" modelName="custom" textColor="#000000" verticalTextPosition="bottom" visible="true" width="121.29296875" x="4.853515624999986" y="6.515625">create Pull-Request<y:LabelModel>
<y:NodeLabel alignment="center" autoSizePolicy="content" fontFamily="Dialog" fontSize="12" fontStyle="plain" hasBackgroundColor="false" hasLineColor="false" height="17.96875" horizontalTextPosition="center" iconTextGap="4" modelName="custom" textColor="#000000" verticalTextPosition="bottom" visible="true" width="117.373046875" x="6.813476562499986" y="6.515625">create Pull request<y:LabelModel>
<y:SmartNodeLabelModel distance="4.0"/>
</y:LabelModel>
<y:ModelParameter>
Expand Down Expand Up @@ -145,7 +145,7 @@
<y:Geometry height="31.0" width="131.0" x="123.89999999999993" y="241.0"/>
<y:Fill color="#FFCC00" transparent="false"/>
<y:BorderStyle color="#000000" raised="false" type="line" width="1.0"/>
<y:NodeLabel alignment="center" autoSizePolicy="content" fontFamily="Dialog" fontSize="12" fontStyle="plain" hasBackgroundColor="false" hasLineColor="false" height="17.96875" horizontalTextPosition="center" iconTextGap="4" modelName="custom" textColor="#000000" verticalTextPosition="bottom" visible="true" width="125.21875" x="2.890624999999986" y="6.515625">update Pull-Request<y:LabelModel>
<y:NodeLabel alignment="center" autoSizePolicy="content" fontFamily="Dialog" fontSize="12" fontStyle="plain" hasBackgroundColor="false" hasLineColor="false" height="17.96875" horizontalTextPosition="center" iconTextGap="4" modelName="custom" textColor="#000000" verticalTextPosition="bottom" visible="true" width="121.298828125" x="4.850585937499986" y="6.515625">update Pull request<y:LabelModel>
<y:SmartNodeLabelModel distance="4.0"/>
</y:LabelModel>
<y:ModelParameter>
Expand Down Expand Up @@ -196,7 +196,7 @@
<y:Geometry height="36.10000000000002" width="131.0" x="746.8624999999998" y="238.45000000000002"/>
<y:Fill color="#FFCC00" transparent="false"/>
<y:BorderStyle color="#000000" raised="false" type="line" width="1.0"/>
<y:NodeLabel alignment="center" autoSizePolicy="content" fontFamily="Dialog" fontSize="12" fontStyle="plain" hasBackgroundColor="false" hasLineColor="false" height="17.96875" horizontalTextPosition="center" iconTextGap="4" modelName="custom" textColor="#000000" verticalTextPosition="bottom" visible="true" width="121.943359375" x="4.5283203125" y="9.065624999999983">merge Pull-Request<y:LabelModel>
<y:NodeLabel alignment="center" autoSizePolicy="content" fontFamily="Dialog" fontSize="12" fontStyle="plain" hasBackgroundColor="false" hasLineColor="false" height="17.96875" horizontalTextPosition="center" iconTextGap="4" modelName="custom" textColor="#000000" verticalTextPosition="bottom" visible="true" width="118.0234375" x="6.48828125" y="9.065624999999983">merge Pull request<y:LabelModel>
<y:SmartNodeLabelModel distance="4.0"/>
</y:LabelModel>
<y:ModelParameter>
Expand Down Expand Up @@ -231,7 +231,7 @@
<y:Fill color="#FFCC00" transparent="false"/>
<y:BorderStyle color="#000000" raised="false" type="line" width="1.0"/>
<y:NodeLabel alignment="center" autoSizePolicy="content" fontFamily="Dialog" fontSize="12" fontStyle="plain" hasBackgroundColor="false" hasLineColor="false" height="31.9375" horizontalTextPosition="center" iconTextGap="4" modelName="custom" textColor="#000000" verticalTextPosition="bottom" visible="true" width="99.28515625" x="15.857421875" y="-0.46875">create backport
Pull-Request<y:LabelModel>
Pull request<y:LabelModel>
<y:SmartNodeLabelModel distance="4.0"/>
</y:LabelModel>
<y:ModelParameter>
Expand Down Expand Up @@ -266,7 +266,7 @@ Pull-Request<y:LabelModel>
<y:Fill color="#FFCC00" transparent="false"/>
<y:BorderStyle color="#000000" raised="false" type="line" width="1.0"/>
<y:NodeLabel alignment="center" autoSizePolicy="content" fontFamily="Dialog" fontSize="12" fontStyle="plain" hasBackgroundColor="false" hasLineColor="false" height="31.9375" horizontalTextPosition="center" iconTextGap="4" modelName="custom" textColor="#000000" verticalTextPosition="bottom" visible="true" width="107.025390625" x="11.9873046875" y="-0.46875">update backport
Pull-Request<y:LabelModel>
Pull request<y:LabelModel>
<y:SmartNodeLabelModel distance="4.0"/>
</y:LabelModel>
<y:ModelParameter>
Expand Down Expand Up @@ -341,7 +341,7 @@ Pull-Request<y:LabelModel>
<y:Fill color="#FFCC00" transparent="false"/>
<y:BorderStyle color="#000000" raised="false" type="line" width="1.0"/>
<y:NodeLabel alignment="center" autoSizePolicy="content" fontFamily="Dialog" fontSize="12" fontStyle="plain" hasBackgroundColor="false" hasLineColor="false" height="31.9375" horizontalTextPosition="center" iconTextGap="4" modelName="custom" textColor="#000000" verticalTextPosition="bottom" visible="true" width="99.935546875" x="15.5322265625" y="2.0812499999999545">merge backport
Pull-Request<y:LabelModel>
Pull request<y:LabelModel>
<y:SmartNodeLabelModel distance="4.0"/>
</y:LabelModel>
<y:ModelParameter>
Expand Down
12 changes: 6 additions & 6 deletions rfcs/0053-pull-request-workflow/pull-request-roles.svg
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit a3be8dc

Please sign in to comment.