From 76dde67d57bb590118a08399eb381a63fb70542d Mon Sep 17 00:00:00 2001 From: optimistanoop Date: Fri, 20 Apr 2018 03:24:07 +0530 Subject: [PATCH 1/2] refactored .github guidelines --- .github/CONTRIBUTING.md | 10 ++++++++++ .github/ISSUE_TEMPLATE.md | 20 ++++++++++++++++---- .github/PULL_REQUEST_TEMPLATE.md | 12 +++++++++--- 3 files changed, 35 insertions(+), 7 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index ca0d7ad..db9e738 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -31,6 +31,16 @@ a proposal for your work first, to be sure that we can use it. Before you submit an issue, please search the issue tracker, maybe an issue for your identified problem already exists and you can join the discussion there only. For bugs, please try to provide as much information possible to reproduce it as possible, that will really help us a lot! +**Great Bug Reports** tend to have: + +- A quick summary and/or background +- Steps to reproduce + - Be specific! + - Give sample code if you can. +- What you expected would happen +- What actually happens +- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work) + ### Submitting a Pull Request (PR) 1. Make sure there is an issue open for the PR and it is assigned to you before starting any work. That way it'll be helpful to eliminate duplicate efforts. 2. Fork the repo. If already have one, checkout the latest master from upstream. diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index a332804..89cb235 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,11 +1,23 @@ -**I'm submitting a ...** -- [ ] bug report -- [ ] feature request +# Template to submit an issue + + - [ ] I have read the [contribution guidelines](https://github.com/UdacityMobileWebScholarship/showcase-app/blob/master/.github/CONTRIBUTING.md) + +-**I'm submitting a ...** + + + - [ ] bug report + - [ ] feature request **Current behavior:** - + **Expected behavior:** **Steps to reproduce:** + + + + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 9c03395..6247f3a 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,4 +1,7 @@ - + Fixes # #### Checklist @@ -9,5 +12,8 @@ Fixes # #### Changes proposed in this pull request: -- -- + + + + From d79bf3eb5dcea4dd97d1135d21f985f0d90f9333 Mon Sep 17 00:00:00 2001 From: optimistanoop Date: Mon, 14 May 2018 14:29:49 +0530 Subject: [PATCH 2/2] review changes for pull_request template --- .github/PULL_REQUEST_TEMPLATE.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 6247f3a..67efaca 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,7 +1,13 @@ +Please provide reference to active issue here. +Add the issue number that is fixed by this PR (In the form Fixes #123) + +Attention !! + +An active issue is required for a PR to be reviewed. +If you do not provide one, you pull request might be closed by collaborators.--> Fixes # #### Checklist @@ -12,8 +18,7 @@ Fixes # #### Changes proposed in this pull request: - +