From 4558248e3f94fec3a582693e8266f257c4da3850 Mon Sep 17 00:00:00 2001 From: Zachary Scott Date: Wed, 26 Dec 2018 10:50:39 +0900 Subject: [PATCH 1/7] Update CODEOWNERS to use DX-Clients group --- .github/CODEOWNERS | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index ba4c2ddea..061399a0d 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1 +1 @@ -* @CircleCI-Public/dx-internal +* @CircleCI-Public/dx-clients From cd7199177a188c1ef37c3ef636a1703415eec1bb Mon Sep 17 00:00:00 2001 From: Zachary Scott Date: Wed, 26 Dec 2018 11:06:53 +0900 Subject: [PATCH 2/7] Add issue template --- .github/ISSUE_TEMPLATE.MD | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE.MD diff --git a/.github/ISSUE_TEMPLATE.MD b/.github/ISSUE_TEMPLATE.MD new file mode 100644 index 000000000..3a3e1c521 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.MD @@ -0,0 +1,19 @@ +**Do you want to request a *feature* or report a *bug*?** + +Be sure to read our [Contribution Guidelines](./CONTRIBUTING.md) before submitting. + +**Did you find a security bug?** + +Please report [security concerns](https://circleci.com/security/) directly following these instructions. + +**What is the current behavior?** + +Can you provide an example? + +**What is the expected behavior?** + +Have this has been reported before? + +**Which version of the CLI and OS are you using? Did this work in previous versions?** + +Please provide the output of `circleci version` and `circleci diagnostic`. From 62eaacf7667522da0da9cebef515841ab0129f49 Mon Sep 17 00:00:00 2001 From: Zachary Scott Date: Wed, 26 Dec 2018 11:27:00 +0900 Subject: [PATCH 3/7] Add info on how to ping our DX-Clients team --- .github/ISSUE_TEMPLATE.MD | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/ISSUE_TEMPLATE.MD b/.github/ISSUE_TEMPLATE.MD index 3a3e1c521..7e81771a1 100644 --- a/.github/ISSUE_TEMPLATE.MD +++ b/.github/ISSUE_TEMPLATE.MD @@ -17,3 +17,5 @@ Have this has been reported before? **Which version of the CLI and OS are you using? Did this work in previous versions?** Please provide the output of `circleci version` and `circleci diagnostic`. + +**If you have any questions, feel free to ping us at `\@CircleCI-Public/dx-clients`.** From 2020b4d5c51e89abd5191bb94038895bdf2a1148 Mon Sep 17 00:00:00 2001 From: Zachary Scott Date: Wed, 26 Dec 2018 11:27:09 +0900 Subject: [PATCH 4/7] Add PR template --- .github/PULL_REQUEST_TEMPLATE.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..18bd18bcd --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,14 @@ +**Here are some helpful tips you can follow when submitting a pull request:** + +1. Fork [the repository](https://github.com/CircleCI-Public/circleci-cli) and create your branch from `master`. +2. Run `make build` in the repository root. +3. If you've fixed a bug or added code that should be tested, add tests! +4. Ensure the test suite passes (`make test`). +5. The `--debug` flag is often helpful for debugging HTTP client requests and responses. +6. Format your code with [gofmt](https://golang.org/cmd/gofmt/). +7. Make sure your code lints (`make lint`). Tip: `make dev` will install `gometalinter`. +8. Run `make doc` (after installing `godoc`) to view the API documentation. +9. Be sure to read our [Contribution Guidelines](./CONTRIBUTING.md). +10. Find out more about [HACKING](./HACKING.md) the CLI. + +If you have any questions, feel free to ping us at `\@CircleCI-Public/dx-clients`. From d249bd932fbce039fb188cb7b8808af17b2ecd20 Mon Sep 17 00:00:00 2001 From: Zachary Scott Date: Wed, 26 Dec 2018 14:24:01 +0900 Subject: [PATCH 5/7] Reduce number of lines and prefer checklist --- .github/ISSUE_TEMPLATE.MD | 14 +++++--------- .github/PULL_REQUEST_TEMPLATE.md | 9 +++++---- 2 files changed, 10 insertions(+), 13 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.MD b/.github/ISSUE_TEMPLATE.MD index 7e81771a1..b8af90ba7 100644 --- a/.github/ISSUE_TEMPLATE.MD +++ b/.github/ISSUE_TEMPLATE.MD @@ -1,10 +1,8 @@ -**Do you want to request a *feature* or report a *bug*?** - -Be sure to read our [Contribution Guidelines](./CONTRIBUTING.md) before submitting. - -**Did you find a security bug?** +- [ ]: I have our [Contribution Guidelines](./CONTRIBUTING.md). +- [ ]: I checked for similar issues and didn't find anything relevant. +- [ ]: This is not a security issue (which should be reported here: https://circleci.com/security/) -Please report [security concerns](https://circleci.com/security/) directly following these instructions. +**Do you want to request a *feature* or report a *bug*?** **What is the current behavior?** @@ -12,10 +10,8 @@ Can you provide an example? **What is the expected behavior?** -Have this has been reported before? - **Which version of the CLI and OS are you using? Did this work in previous versions?** Please provide the output of `circleci version` and `circleci diagnostic`. -**If you have any questions, feel free to ping us at `\@CircleCI-Public/dx-clients`.** +**If you have any questions, feel free to ping us at @CircleCI-Public/dx-clients.** diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 18bd18bcd..dad3d19c3 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,3 +1,7 @@ +- [ ]: I have our [Contribution Guidelines](./CONTRIBUTING.md). +- [ ]: I checked for similar issues and didn't find anything relevant. +- [ ]: This is not a security issue (which should be reported here: https://circleci.com/security/) + **Here are some helpful tips you can follow when submitting a pull request:** 1. Fork [the repository](https://github.com/CircleCI-Public/circleci-cli) and create your branch from `master`. @@ -7,8 +11,5 @@ 5. The `--debug` flag is often helpful for debugging HTTP client requests and responses. 6. Format your code with [gofmt](https://golang.org/cmd/gofmt/). 7. Make sure your code lints (`make lint`). Tip: `make dev` will install `gometalinter`. -8. Run `make doc` (after installing `godoc`) to view the API documentation. -9. Be sure to read our [Contribution Guidelines](./CONTRIBUTING.md). -10. Find out more about [HACKING](./HACKING.md) the CLI. -If you have any questions, feel free to ping us at `\@CircleCI-Public/dx-clients`. +**If you have any questions, feel free to ping us at @CircleCI-Public/dx-clients.** From 887414f9956136313ecc21815b51938e8877b2eb Mon Sep 17 00:00:00 2001 From: Zachary Scott Date: Wed, 26 Dec 2018 15:53:10 +0900 Subject: [PATCH 6/7] Move to .md --- .github/{ISSUE_TEMPLATE.MD => ISSUE_TEMPLATE.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename .github/{ISSUE_TEMPLATE.MD => ISSUE_TEMPLATE.md} (100%) diff --git a/.github/ISSUE_TEMPLATE.MD b/.github/ISSUE_TEMPLATE.md similarity index 100% rename from .github/ISSUE_TEMPLATE.MD rename to .github/ISSUE_TEMPLATE.md From ed17405b42d7c0cdb82c8fcf2b02fe425896449b Mon Sep 17 00:00:00 2001 From: Zachary Scott Date: Wed, 26 Dec 2018 16:30:30 +0900 Subject: [PATCH 7/7] Fix markdown syntax for task list --- .github/ISSUE_TEMPLATE.md | 6 +++--- .github/PULL_REQUEST_TEMPLATE.md | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index b8af90ba7..8995f4953 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,6 +1,6 @@ -- [ ]: I have our [Contribution Guidelines](./CONTRIBUTING.md). -- [ ]: I checked for similar issues and didn't find anything relevant. -- [ ]: This is not a security issue (which should be reported here: https://circleci.com/security/) +- [ ] I have our [Contribution Guidelines](./CONTRIBUTING.md). +- [ ] I checked for similar issues and didn't find anything relevant. +- [ ] This is not a security issue (which should be reported here: https://circleci.com/security/) **Do you want to request a *feature* or report a *bug*?** diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index dad3d19c3..110777f42 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,6 +1,6 @@ -- [ ]: I have our [Contribution Guidelines](./CONTRIBUTING.md). -- [ ]: I checked for similar issues and didn't find anything relevant. -- [ ]: This is not a security issue (which should be reported here: https://circleci.com/security/) +- [ ] I have our [Contribution Guidelines](./CONTRIBUTING.md). +- [ ] I checked for similar issues and didn't find anything relevant. +- [ ] This is not a security issue (which should be reported here: https://circleci.com/security/) **Here are some helpful tips you can follow when submitting a pull request:**