Skip to content

Commit

Permalink
[chore] updated github templates for issues and pull requests.
Browse files Browse the repository at this point in the history
  • Loading branch information
oa-coinbase committed Apr 29, 2020
1 parent f8c6333 commit 51f2099
Show file tree
Hide file tree
Showing 2 changed files with 84 additions and 26 deletions.
40 changes: 40 additions & 0 deletions .github/ISSUE_REQUEST_TEMPLATE/issue_request_template.md
@@ -0,0 +1,40 @@
<!---
ISSUE TITLE: Please make your title easy to understand short summary, usually 4-10 words. Examples:
> Cannot install dependencies due to version error.
> How do I set a callback redirect url?
> Curl with API Key not working.
--->

**Severity:** <severity>

<!---
Replace <severity> with a priority ranking P0-P3:
> P0: severe/ blocking - completely broken or unusable.
> P1: high priority - breaking but non-essential.
> P2: medium priority - non-breaking issue.
> P3: low priority - questions or nice-to-haves.
--->

**Description:**
<description>

<!---
Replace <description> with a detailed summary of the issue or question, including any relevant context to avoid follow-up questions.
--->

**Steps to Reproduce:**
<steps>

<!---
Replace <steps> with instructions so others can reproduce.
--->

**Configuration:**

<!---
Replace <version> based on your environment (run `node -v` and `npm -v`).
--->
* Node.js version: <version>
* NPM version: <version>
70 changes: 44 additions & 26 deletions .github/PULL_REQUEST_TEMPLATE/pull_request_template.md
@@ -1,35 +1,53 @@
**Type of change**
<!---
PR TITLE: Please name your pull request according to this format: [type] short summary. Examples:
<!--- Please delete options that are not relevant. --->
- Bug fix (non-breaking change which fixes an issue)
- New feature (non-breaking change which adds functionality)
- Breaking change (fix or feature that would cause existing functionality to not work as expected)
- This change requires a documentation update
> [bugfix] added callback function to charge example.
> [feature] enabled refunds event signature.
> [chore] updated docs with webhooks instructions.
--->

**Issue:** <link>

<!---
IMPORTANT: Please do not create a Pull Request without creating an issue first. Replace <link> with the url link to the issue.
--->

**Type:** <type>

**Description**
<!---
Same as in title, replace <type> with one of the following options: bugfix | feature | chore
<!--- Replace this comment with:
- a summary of the change, including any relevant motivation or context. --->
> bugfix: a change which fixes an issue.
> feature: a change which adds functionality.
> chore: doc updates, dependencies, refactor, etc.
--->

**How have you tested this change?**
**Description:** <description>

<!--- Replace this comment with:
- a description of how you verified your changes,
- instructions so others can reproduce,
- and any configuration details. --->
<!---
Replace <description> with a detailed summary of the change, including any relevant context to avoid follow-up questions.
--->

**Configuration**
**Testing:** <testing>

<!--- Please update versions based on your use (run `node -v` and `npm -v`). --->
* Node.js version: 10.15.1
* NPM version: 6.9.0
<!---
Replace <testing> with a description of how you've tested/ verified your changes.
--->

<!--- Please ensure you have done the following:
- I have performed a self-review of my own code
- I have commented my code, particularly in hard-to-understand areas
- I have made corresponding changes to the documentation
- My changes generate no new warnings
- I have added tests that prove my fix is effective or that my feature works
- New and existing unit tests pass locally with my changes
- Any dependent changes have been merged and published in downstream modules
**Configuration:**

<!---
Replace <version> based on your environment (run `node -v` and `npm -v`).
--->
* Node.js version: <version>
* NPM version: <version>

<!---
CHECKLIST: Please ensure you have done the following.
> 1. I have performed a self-review of my own code.
> 2. I have commented my code, particularly in hard-to-understand areas.
> 3. I have made relevant changes to the documentation.
> 4. My changes generate no new warnings.
> 5. I have added any tests that prove my fix is effective or that my feature works.
> 6. New and existing unit tests pass locally with my changes.
--->

0 comments on commit 51f2099

Please sign in to comment.