Skip to content

Commit

Permalink
Merge pull request #254 from mobi/update_contribution
Browse files Browse the repository at this point in the history
[Chore] Update Contribution and PR Template
  • Loading branch information
grahamhency authored Oct 8, 2019
2 parents ac2f534 + e15fbe2 commit 459328e
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 16 deletions.
36 changes: 20 additions & 16 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,6 @@ _**Note:** The guide for contributing to this repo is based on the [contribution
## Code of Conduct
Please read and follow our [Code of conduct](https://github.com/mobi/goponents/blob/master/CODE_OF_CONDUCT.md).

## Got a question, problem, or feedback?
Feel free to open up [an issue](https://github.com/mobi/goponents/issues/new/choose) using the appropriate template.

When any sort of issue is created, depending on the impact or urgency of the issue, one of our [contributors](https://github.com/mobi/goponents/graphs/contributors) will respond as quickly as appropriate on the issue itself. We will try to give a timeline and release schedule for any request that is made.

We would also welcome anyone to open up a [pull request]() for a bug or issue experienced in order to expedite the process.

## Feature requests
You can request a new feature by submitting an issue to our [GitHub Repository](https://github.com/mobi/goponents/issues). If you would like to _implement_ a new feature, please submit an issue with a proposal for your work first.

Expand All @@ -19,11 +12,15 @@ Our team will first make sure of the following:
2. Where it fits into our current road map.
3. What design resources and support will be needed before the feature work can begin.

Please consider what kind of change it is:
## Working Issues
Before working on an issue, you must claim it. To do so, simply comment on the issue stating that you're looking into it.
Once claimed, a contributor will modify the issue and apply the appropriate labels and milestones.

For a **Major Feature**, first open an issue and outline your proposal so that it can be discussed. This will also allow us to better coordinate our efforts, prevent duplication of work, and help you to craft the change so that it is successfully accepted into the project.
### What issues can be worked?

**Small Features** can be crafted and directly submitted as a Pull Request so long as they have the appropriate design support.
Any issue that does not have the `Needs Triaged` milestone can be worked.

Issues labeled as `bugs` take priority over general a `chore` or `feature`.

## Submitting a pull request (PR)
Before you submit your pull request (PR) consider the following guidelines:
Expand All @@ -48,13 +45,20 @@ Before you submit your pull request (PR) consider the following guidelines:
```bash
git push origin my-branch-name
```
9. In GitHub, send a pull request to `goponents:master`.
- If we suggest changes then:
1. Make the required updates.
2. Re-run the test suite to ensure tests are still passing.
3. Rebase your branch and force push to your GitHub repository (this will update your Pull Request):
9. In GitHub, send a pull request to `goponents:dev`.
- Please format the description of your PR with our [pull request template](https://github.com/mobi/goponents/blob/master/PULL_REQUEST_TEMPLATE)
- If we suggest changes then:
1. Make the required updates.
2. Re-run the test suite to ensure tests are still passing.
3. Rebase your branch and force push to your GitHub repository (this will update your Pull Request):
```
git rebase master -i
git rebase dev -i
git push -f
```
## Got a question, problem, or feedback?
Feel free to open up [an issue](https://github.com/mobi/goponents/issues/new/choose) using the appropriate template.
When any sort of issue is created, depending on the impact or urgency of the issue, one of our [contributors](https://github.com/mobi/goponents/graphs/contributors) will respond as quickly as appropriate on the issue itself. We will try to give a timeline and release schedule for any request that is made.
We would also welcome anyone to open up a [pull request]() for a bug or issue experienced in order to expedite the process.
6 changes: 6 additions & 0 deletions PULL_REQUEST_TEMPLATE
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
## Why do we need this?

## How does this solve that?

## Additional Info
Fixes (issue)

0 comments on commit 459328e

Please sign in to comment.