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.

Sign up for GitHub

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

PR review policy #923

Merged
merged 6 commits into from
Apr 23, 2017
Merged

PR review policy #923

Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c7d5767
Merge remote-tracking branch 'storybooks/master'
shilman Apr 20, 2017
ca38478
PR review policy
shilman Apr 20, 2017
034e0ab
Updates per @tmeasday 's review
shilman Apr 20, 2017
cc4f4c9
In github, tags are called labels :)
shilman Apr 20, 2017
588dba4
Clarification on self-merging
shilman Apr 20, 2017
1a1a3f9
Merge branch 'master' into contributing-reviewer-policy
ndelangen Apr 23, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,12 @@ We welcome your contributions. There are many ways you can help us. This is few

Before you submit a new PR, make you to run `npm test`. Do not submit a PR if tests are failing. If you need any help, create an issue and ask.

### Reviewing PRs

**As a PR submitter**, you should reference the issue if there is one, include a short description of what you contributed and, if it is a code change, instructions for how to manually test out the change. This is informally enforced by our [PR template](https://github.com/storybooks/storybook/blob/master/.github/PULL_REQUEST_TEMPLATE.md). If you have merge rights and the changes are trivial, feel free to force merge without a review.
Copy link
Member

Choose a reason for hiding this comment

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

This isn't quite what I meant.

What I meant was:

If your PR is reviewed as only needing trivial changes (e.g. small typos etc), and you have commit access, then you can merge the PR after making those changes.


**As a PR reviewer**, you should read through the changes and comment on any potential problems. If you see something cool, a kind word never hurts either! Additionally, you should follow the testing instructions and manually test the changes. If the instructions are missing, unclear, or overly complex, feel free to request better instructions from the submitter. Unless the PR is marked with the `do not merge` tag, if you approve the review and there is no other required discussion or changes, you should also go ahead and merge the PR.

## Issue Triage

If you are looking for a way to help the project, triaging issues is a great place to start. Here's how you can help:
Expand Down Expand Up @@ -85,7 +91,7 @@ If an issue is a `bug`, and it doesn't have a clear reproduction that you have p

## Development Guide

> If you want to work on a UI feature, refer to the [Storybook UI](https://github.com/storybooks/storybook/tree/master/storybook-ui) project.
> If you want to work on a UI feature, refer to the [Storybook UI](https://github.com/storybooks/storybook/tree/master/packages/storybook-ui) project.

This project written in ES2016+ syntax so, we need to transpile it before use.
So run the following command:
Expand Down