Skip to content

Commit

Permalink
docs(contributing): update contributing.md and github templates
Browse files Browse the repository at this point in the history
  • Loading branch information
sharvit committed Jul 26, 2019
1 parent e2c643b commit a28b121
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 44 deletions.
5 changes: 4 additions & 1 deletion .github/issue_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,10 @@

<!--- reproduce this bug. Include code or screenshot if relevant -->

1. 2. 3. 4.
1.
2.
3.
4.

## Environment

Expand Down
51 changes: 13 additions & 38 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@
<!--- Provide a general summary of your changes in the Title above -->
<!---
Please read the contribution guide before sending your first commit:
https://github.com/sharvit/generator-node-mdl/blob/master/contributing.md)
-->

## PR Type

<!--- What types of changes does your code introduce? -->

<!-- Put an `x` in all the boxes that apply: -->
<!---
What types of changes does your code introduce?
Put an `x` in all the boxes that apply:
-->

* [ ] Bugfix
* [ ] Feature
Expand All @@ -17,37 +21,8 @@

## Description

<!--- Describe your changes in detail -->

<!--- Why is this change required? What problem does it solve? -->

<!--- If it fixes an open issue, please link to the issue here. -->

## How Has This Been Tested?

<!--- Please describe in detail how you tested your changes. -->

<!--- Include details of your testing environment, and the tests you ran to -->

<!--- see how your change affects other areas of the code, etc. -->

## Screenshots (if appropriate):

## Does this PR introduce a breaking change?

<!-- If this PR contains a breaking change, -->

<!-- please also describe the impact and migration path for existing applications -->

* [ ] Yes
* [ ] No

## Checklist:

<!--- Put an `x` in all the boxes that apply. -->

<!--- If you‘re unsure about any of these, don‘t hesitate to ask. We‘re here to help! -->

* [ ] My change requires a change to the documentation.
* [ ] I have updated the documentation accordingly.
* [ ] I have read the [`contributing.md`](https://github.com/sharvit/generator-node-mdl/blob/master/contributing.md).
<!---
Describe your changes in detail
Why is this change required? What problem does it solve?
If it fixes an open issue, please link to the issue here.
-->
12 changes: 7 additions & 5 deletions contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,15 +44,17 @@ Run linter to validate your commit message:
yarn lint:commit
```

## Committing and Pushing changes
## Creating Pull Requests

Create a branch and start hacking:
1. Create a branch:

```sh
git checkout -b my-branch
```

Commit and push your changes:
2. Happy Hacking 🎉: Start hacking and creating code changes.

3. Commit your changes:

`generator-node-mdl` uses [commitizen](https://github.com/commitizen/cz-cli) to create commit messages so [semantic-release](https://github.com/semantic-release/semantic-release) can automatically create releases.

Expand All @@ -62,13 +64,13 @@ yarn commit
# answer the questions
```

Push your changes:
4. Push your changes:

```sh
git push origin my-branch
```

Open this project on [GitHub](https://github.com/sharvit/generator-node-mdl), then click “Compare & pull request”.
5. Open [this project on GitHub](https://github.com/sharvit/generator-node-mdl), then click “Compare & pull request”.

## Help needed

Expand Down

0 comments on commit a28b121

Please sign in to comment.