Skip to content

Commit

Permalink
docs(guidelines): improve contribution guidelines (#180)
Browse files Browse the repository at this point in the history
change templates + force codemods on breaking changes
  • Loading branch information
acatl committed Jan 25, 2018
1 parent 8ac4f37 commit a8e98b8
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 18 deletions.
31 changes: 15 additions & 16 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,37 +3,36 @@ Thanks for your interest in the project. We appreciate bugs filed and PRs submit
Please make sure that you are familiar with and follow the Code of Conduct for
this project (found in the CODE_OF_CONDUCT.md file).
Please fill out this template with all the relevant information so we can
Please fill/un-comment out this template with all the relevant information so we can
understand what's going on and fix the issue.
-->

- `data-point` version:
- `node` version:
- `npm` version:
**Problem description**:


**Any relevant code**:

```javascript
**Suggested solution**:


```

**What you did**:
<!--
REPORTING BUG:
If you are reporting a bug, please provide the full error message/screenshots/anything.
-->

**What happened**:

<!-- Please provide the full error message/screenshots/anything -->

**Reproduction**:

<!--
If you have a link or example that reproduces your issue please include it. A reproduction with as little code as possible is better.
-->
**Reproduction**:

-- paste your link here --

**Problem description**:

<!--If you have a link or example that reproduces your issue please include it. A reproduction with as little code as possible is better.-->

**Environment**:

**Suggested solution**:
- `data-point` version:
- `node` version:
- `npm` version:
9 changes: 9 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,14 @@ contributing guidelines (found in the CONTRIBUTING.md file).
Please fill out the information below to expedite the review and (hopefully)
merge of your pull request!
BREAKING CHANGES:
If your PR includes a breaking change, please submit it with a codemod under
data-point-codemods that will help users upgrade their codebase.
Breaking changes without a codemod will not be accepted unless a codemod is not
viable or does not apply to the specific situation.
-->

<!-- What changes are being made? (What feature/bug is being fixed here?) -->
Expand All @@ -24,6 +32,7 @@ merge of your pull request!
**Checklist**:
<!-- add "N/A" to the end of each line that's irrelevant to your changes -->
<!-- to check an item, place an "x" in the box like so: "- [x] Documentation" -->
- [ ] Has Breaking changes
- [ ] Documentation
- [ ] Tests
- [ ] Ready to be merged <!-- In your opinion, is this ready to be merged as soon as it's reviewed? -->
Expand Down
15 changes: 13 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,10 +57,21 @@ We will only be supporting node 6 and above, please make sure the code you use i

1. Fork it
2. Create your feature branch `git checkout -b feature/my-new-feature`
3. Commit your changes through `npm run commit`
3. Commit your changes through `yarn run commit`
4. Push to the branch `git push origin feature/my-new-feature`
5. Create a new [Pull Request](https://github.com/ViacomInc/data-point/compare)

### Updating Documentation

Please update the respective README.md files with details of changes to the interface.

**Note on commit messages**: All commit messages **must** use [commitizen](http://commitizen.github.io/cz-cli/) format to be accepted, to ensure you use this format, only commit through `yarn run commit`.
### Commit message format

All commit messages **must** use [commitizen](http://commitizen.github.io/cz-cli/) format to be accepted, to ensure you use this format, only commit through `yarn run commit`.

### Breaking changes

If your pull request includes a breaking change, please submit it with a [codemod](https://github.com/facebook/jscodeshift) under
data-point-codemods that will help users upgrade their codebase.

Breaking changes without a codemod will not be accepted unless a codemod is not viable or does not apply to the specific situation.

0 comments on commit a8e98b8

Please sign in to comment.