primal/athens
1
0
Fork 0
mirror of https://github.com/gomods/athens synced 2026-02-03 09:50:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

adding document that explains how reviews happen on PRs (#470)

Browse Source 
* WIP: adding document that explains how reviews happen on PRs

Fixes https://github.com/gomods/athens/issues/467

* adding more steps

* Incorporate review feedback

co-authored-by: Carolyn Van Slyck <carolyn.vanslyck@microsoft.com>
co-authored-by: Aaron Schlesinger <arschles@gmail.com>

* Fix verify your work to specify what the CI runs

co-authored-by: Carolyn Van Slyck <carolyn.vanslyck@microsoft.com>
co-authored-by: Aaron Schlesinger <arschles@gmail.com>

* Keep important PRs open longer

co-authored-by: Carolyn Van Slyck <carolyn.vanslyck@microsoft.com>
co-authored-by: Aaron Schlesinger <arschles@gmail.com>
This commit is contained in:
Aaron Schlesinger
2018-08-24 15:34:49 -07:00
committed by Rob j Loranger
parent 539700e598
commit 87f65bac7a
3 changed files with 38 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CONTRIBUTING.md
+9 -1
View File
@@ -3,7 +3,7 @@ Hurray! We are glad that you want to contribute to our project! 👍
If this is your first contribution, not to worry! We have a great [tutorial](https://www.youtube.com/watch?v=bgSDcTyysRc) to help you get started, and you can always ask us for help in the `#athens` channel in the [gopher slack](https://invite.slack.golangbridge.org/). We'll give you whatever guidance you need.
## Verify your work
Run `make verify` to run all the same validations that our CI process runs, such
Run `make verify test-unit test-e2e` to run all the same validations that our CI process runs, such
as checking that the standard go formatting is applied, linting, etc.
## Setup your dev environment
@@ -26,3 +26,11 @@ you must run `make setup-dev-env` first, otherwise you will see errors like the
```
error connecting to storage (no reachable servers)
```
## Next Steps
After you get your code working, submit a Pull Request (PR) following
[Github's PR model](https://help.github.com/articles/about-pull-requests/).
If you're interested, take a look at [REVIEWS.md](REVIEWS.md) to learn how
your PR will be reviewed and how you can help get it merged.
DEVELOPMENT.md
+1 -1
View File
@@ -67,7 +67,7 @@ buffalo dev
To run the proxy:
```consols
```console
cd cmd/proxy
buffalo dev
```
REVIEWS.md
+28
View File
@@ -0,0 +1,28 @@
# Pull Request Reviews
Whether you're contributing or reviewing pull requests, this document can help you!
- If you're reviewing, it can help you understand what to do
- If you're submitting a pull request, it can help you understand what folks
are going to do, how to help them, and how to get your pull request
merged faster
## Steps
We follow a lightweight list of steps in order to review
[pull requests in the Athens project](https://github.com/gomods/athens/pulls)
(if you're not familiar with pull requests, see
[here](https://help.github.com/articles/about-pull-requests/)).
Here they are:
- Anyone, whether or not they are an official [contributor](https://github.com/orgs/gomods/teams/contributors),
can review a pull request.
- Pull requests must be reviewed by at least one
[maintainer](https://github.com/orgs/gomods/teams/maintainers), enforced by GitHub.
Only maintainers can merge a pull request.
- For important changes we want to make sure that people in other time zones have a chance to
review, so keep the pull request open for 24-36 hours before merging.
- Pull requests have to pass continuous integration (CI) tests.