From f7eb8a276ca4d81acb58878fb0283d4d169790da Mon Sep 17 00:00:00 2001 From: Sara Vieira Date: Mon, 30 Oct 2017 17:12:00 +0000 Subject: [PATCH] add issue and pull request templates (#819) * feat(all) - Add issue and pull ruequest templates * Update PULL_REQUEST_TEMPLATE.md * Create COMMIT_GUIDELINES.md * Update PULL_REQUEST_TEMPLATE.md * Update PULL_REQUEST_TEMPLATE.md * Update COMMIT_GUIDELINES.md --- .github/COMMIT_GUIDELINES.md | 25 +++++++++++++++++++++++++ .github/ISSUE_TEMPLATE.md | 24 ++++++++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 22 ++++++++++++++++++++++ 3 files changed, 71 insertions(+) create mode 100644 .github/COMMIT_GUIDELINES.md create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/COMMIT_GUIDELINES.md b/.github/COMMIT_GUIDELINES.md new file mode 100644 index 00000000..27ee144a --- /dev/null +++ b/.github/COMMIT_GUIDELINES.md @@ -0,0 +1,25 @@ +# Commit Guidelines + +``` +<(scope)?>: +``` + +Where type is one of: + +``` +build +chore +ci +docs +feat +fix +perf +refactor +revert +style +test +``` + +And where scope is one of ui-toolkit, my-joy-beta, cloudapi-gql, boilerplate, and create-instance. + +*The recommended method to commit should be by running npm run commit.* diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 00000000..e8cbe0e0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,24 @@ +* **I'm submitting a ... ** + - [ ] bug report + - [ ] feature request + - [ ] design request + +* **What is the current behavior?** + + +* **If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem** + + +* **What is the expected behavior?** + + + +* **What is the motivation / use case for changing the behavior?** + + + +* **If the current behavior is a bug, please provide your browser** + + + +* **Other information** diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..d3dfaa8e --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,22 @@ +* **Please check if the PR fulfills these requirements** +- [ ] The commit message follows our [guidelines](https://github.com/yldio/joyent-portal/blob/issue-template/.github/COMMIT_GUIDELINES.md) +- [ ] Tests for the changes have been added (for bug fixes / features) + + +* **What kind of change does this PR introduce?** (Bug fix, feature, docs update, ...) + + + +* **Does this PR close an issue?** (If not please create one) + + + +* **What is the new behavior (if this is a feature change)?** + + + +* **Does this PR introduce a breaking change?** (What changes might users need to make in their application due to this PR?) + + + +* **Other information**: