From a28b12168f067c7485dcfe4deb311d8e5296606f Mon Sep 17 00:00:00 2001 From: Avi Sharvit Date: Fri, 26 Jul 2019 13:38:37 +0300 Subject: [PATCH] docs(contributing): update contributing.md and github templates --- .github/issue_template.md | 5 +++- .github/pull_request_template.md | 51 ++++++++------------------------ contributing.md | 12 ++++---- 3 files changed, 24 insertions(+), 44 deletions(-) diff --git a/.github/issue_template.md b/.github/issue_template.md index b4f0aa0..c70d9dd 100644 --- a/.github/issue_template.md +++ b/.github/issue_template.md @@ -34,7 +34,10 @@ -1. 2. 3. 4. +1. +2. +3. +4. ## Environment diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 6aa552d..fd8b009 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,10 +1,14 @@ - + ## PR Type - - - + * [ ] Bugfix * [ ] Feature @@ -17,37 +21,8 @@ ## Description - - - - - - -## How Has This Been Tested? - - - - - - - -## Screenshots (if appropriate): - -## Does this PR introduce a breaking change? - - - - - -* [ ] Yes -* [ ] No - -## Checklist: - - - - - -* [ ] 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). + diff --git a/contributing.md b/contributing.md index 52177de..0db808d 100644 --- a/contributing.md +++ b/contributing.md @@ -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. @@ -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