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.

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

Update documentation on contributions #217

Merged
merged 2 commits into from
Mar 20, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
14 changes: 11 additions & 3 deletions docs/project-documentation/contributing-workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ We use and recommend the following workflow:
- If your change adds a new API, follow the [API Review Process](api-review-process.md).
- Clearly state that you are going to take on implementing it, if that's the case. You can request that the issue be assigned to you. Note: The issue filer and the implementer don't have to be the same person.
2. Create a personal fork of the repository on GitHub (if you don't already have one).
3. Create a branch off of **dev** (`git checkout -b mybranch`).
3. Create a branch off of **master** (`git checkout -b mybranch`).
- Name the branch so that it clearly communicates your intentions, such as issue-123 or githubhandle-issue.
- Branches are useful since they isolate your changes from incoming changes from upstream. They also enable you to create multiple PRs from the same fork.
4. Make and commit your changes.
Expand All @@ -137,9 +137,17 @@ We use and recommend the following workflow:
6. Build the repository with your changes.
- Make sure that the builds are clean.
- Make sure that the tests are all passing, including your new tests.
7. Create a pull request (PR) against the upstream repository's **dev** branch.
- Push your changes to your fork on GitHub (if you haven't already).
7. Push your changes to your fork on GitHub (if you haven't already).
8. Create a pull request (PR) against the upstream repository's **master** branch.

Note: It is OK for your PR to include a large number of commits. Once your change is accepted, you will be asked to squash your commits into one or some appropriately small number of commits before your PR is merged.

Note: It is OK to create your PR as "[WIP]" on the upstream repo before the implementation is done. This can be useful if you'd like to start the feedback process concurrent with your implementation. State that this is the case in the initial PR comment.

## Working on an open issue (including _up-for-grabs_)

When you want to work on an open issue we recommend the following.

- Issues labeled with [_investigating_](labels.md#investigating): if the current status doesn't seem updated or clear, add a comment asking for clarification before start any work on it.
- Issues labeled with [_under-review_](labels.md#under-review): if the current status doesn't seem updated or clear, add a comment asking for a clarification before start any work on it.
- Issues labeled with [_up-for-grabs_](labels.md#up-for-grabs): add a comment stating your interest and the issue will be assigned to you and the label switched to _in progress_.
5 changes: 3 additions & 2 deletions docs/project-documentation/labels.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@
| --- | --- | --- |
| bug | The issue concerns a bug in the code | The issue concerns a bug in the code |
| enhancement | The issue is an improvement to the code | The pull request is an improvement to the code |
| up-for-grabs | The issue has been discussed and it's ready to for someone to start working on it. It's not assigned to a particular person. If you want to work on it, just add a comment saying so and it's yours! | Normally not applicable (see comments if observed on a pull request) |
| up-for-grabs <a id="up-for-grabs"></a> | The issue has been discussed and it's ready for someone to start working on it. It's not assigned to a particular person. If you want to work on it, just add a comment saying so and it's yours! | Normally not applicable (see comments if observed on a pull request) |
| investigating <a id="investigating"></a> | The issue is being investigated by the team or by a community member. If the status is not clear, better ask for an update about it. | n/a |
| question | The issue is a question | Normally not applicable (see comments if observed on a pull request) |
| code review | n/a | The pull request is under review |
| needs discussion | The issue needs further discussion before an actionable decision can be made | The pull request needs further discussion before an actionable decision can be made |
Expand All @@ -23,7 +24,7 @@
| FEEDBACK REQUESTED | Feedback from the community is requested. Please step in and add your comment, that is if you have anything relevant to say about it. | Normally not applicable (see comments if observed on a pull request) |
| help wanted | If this issue has any work assigned or has already started to be addressed in a pull request help is welcomed. If you are willing to help add a comment to coordinate with the people already working on it. | Help is welcomed for this pull request. If you are willing to help add a comment to coordinate with the people already working on it. |
| DONE | The work on the issue is completed | n/a |
| under review | n/a | The pull request is being reviewed |
| under review <a id="under review"></a> | The issue (probably a feature request) is under review and a decision hasn't been made | n/a |
| trivial | The work required to complete this issue is considered to be very simple and it shouldn't pose any significant challenge. It can be completed in a very short time. It doesn't require any particular skills or deep knowledge on the matter or the project. | n/a |
| non trivial | The work required to complete this issue is considered to be somewhat complex. It requires a particular skill set or deep knowledge on the matter or about the matter or the project architecture. | n/a |
| area-Config-and-Build | The issue is related with the configuration and build of **nanoFramework** | The pull request is related with the configuration and build of **nanoFramework** |
Expand Down