development/github-desktop
development/github-desktop
1
0
Fork 0
mirror of https://github.com/desktop/desktop synced 2024-09-13 21:31:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

Use CONTRIBUTING instead

Browse source
This commit is contained in:
joshaber 2016-08-08 09:25:05 -04:00
parent 32d513b6b4
commit 3a2975120e
3 changed files with 18 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,17 @@
# How We Work
All changes are reviewed and the entire team is responsible for doing review.
The usual flow:
1. **Contributor** a opens pull request.
2. If they're still working on it, they preface the title with `[WIP]` (**W**ork **I**n **P**rogress).
3. When it's ready for review, they comment on it saying so.
4. Suddenly a wild **reviewer** appears!
5. **Reviewer** assigns the PR to themselves.
6. **Reviewer** leaves line comments with suggestions or questions.
7. When the **reviewer** is done they comment on the PR with an emoji, meme, pokémon, or words.
8. The **contributor** responds to feedback, makes changes, etc.
9. When the **contributor** is ready for the **reviewer** to re-review, they comment on the PR with an emoji, meme, pokémon, or words.
10. Goto 6 until both parties are happy with the PR.
11. The **reviewer** merges the PR and deletes the branch.

2
docs/README.md
View file

@ -3,5 +3,5 @@
This is the [GitHub Desktop](https://github.com/desktop/desktop) product development documentation.
- **[Getting started](getting-started.md)**
- **[How we work](how-we-work.md)**
- **[How we work](../CONTRIBUTING.md)**
- **[Styleguide](styleguide.md)**

17
docs/how-we-work.md
View file

@ -1,17 +0,0 @@
# How We Work
All changes are reviewed and the entire team is responsible for doing review.
The usual flow:
1. A contributor opens pull request.
2. If they're still working on it, they preface the title with `[WIP]`.
3. When it's ready for review, they comment on it saying so.
4. Suddenly a wild reviewer appears!
5. The reviewer assigns the PR to themselves.
6. The reviewer leaves line comments with suggestions or questions.
7. When the reviewer is done they comment on the PR with an emoji, meme, pokémon, or words.
8. The author responds to feedback, makes changes, etc.
9. When the author is ready for the reviewer to re-review, they comment on the PR with an emoji, meme, pokémon, or words.
10. Goto 6 until both parties are happy with the PR.
11. The reviewer merges the PR and deletes the branch.