Skip to content

Commit

Permalink
chore: Create github issue and pull request templates
Browse files Browse the repository at this point in the history
  • Loading branch information
offirgolan authored and jasonmit committed Feb 22, 2019
1 parent f2eb09f commit e9678c4
Show file tree
Hide file tree
Showing 3 changed files with 111 additions and 0 deletions.
66 changes: 66 additions & 0 deletions .github/issue_template.md
@@ -0,0 +1,66 @@
## Prerequisites

- We realize there is a lot of data requested here. We ask only that you do your best to provide as much information as possible so we can better help you.
- Read the [contributing guidelines](https://github.com/Netflix/pollyjs/blob/master/CONTRIBUTING.md).
- Ensure the issue isn't already reported.
- Should be reproducible with the latest @pollyjs package versions.

> _Delete the above section and the instructions in the sections below before submitting_
## Description

If this is a feature request, explain why it should be added. Specific use-cases are best.

For bug reports, please provide as much _relevant_ info as possible.

### Shareable Source

```js
// Avoid posting hundreds of lines of source code.
// Edit to just the relevant portions.
```

### Error Message & Stack Trace

```
COPY THE ERROR MESSAGE, INCLUDING STACK TRACE HERE
```

### Config

Copy the config used to setup the Polly instance:

```js
new Polly('Recording Name', {
// config...
});
```

### Dependencies

Copy the @pollyjs dependencies from `package.json`:

```json
{
"@pollyjs/core": "latest",
"@pollyjs/adapter-x": "latest",
"@pollyjs/persister-x": "latest"
}
```

## Relevant Links

- If your project is public, link to the repo so we can investigate directly.
- **BONUS POINTS:** Create a [minimal reproduction](http://stackoverflow.com/help/mcve) and upload it to GitHub. This will get you the fastest support.

## Environment

Tell us which operating system you are using, as well as which versions of Node.js and npm/yarn. If applicable, include the browser and the corresponding version.

Run the following to get it quickly:

```
node -e "var os=require('os');console.log('Node.js ' + process.version + '\n' + os.platform() + ' ' + os.release())"
npm --version
yarn --version
```
38 changes: 38 additions & 0 deletions .github/pull_request_template.md
@@ -0,0 +1,38 @@
<!--- Provide a general summary of your changes in the Title above -->

## Description

<!--- Describe your changes in detail -->

## Motivation and Context

<!---
Why is this change required? What problem does it solve?
If it fixes an open issue, please link to the issue here.
-->

## Types of Changes

<!---
What types of changes does your code introduce? Put an `x` in all the boxes that apply:
-->

- [ ] 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 change)

## Checklist

<!---
Go over all the following points, and put an `x` in all the boxes that apply.
If you're unsure about any of these, don't hesitate to ask. We're here to help!
-->

- [ ] I have added tests to cover my changes.
- [ ] My change requires a change to the documentation.
- [ ] I have updated the documentation accordingly.
- [ ] My code follows the code style of this project.
- [ ] My commits and the title of this PR follow the [Conventional Commits Specification](https://www.conventionalcommits.org).
- [ ] I have read the [contributing guidelines](https://github.com/Netflix/pollyjs/blob/master/CONTRIBUTING.md).
7 changes: 7 additions & 0 deletions CONTRIBUTING.md
Expand Up @@ -50,6 +50,13 @@ changes.
yarn docs:serve
```

## Conventional Commits

Lerna depends on the use of the [Conventional Commits Specification](https://conventionalcommits.org/)
to determine the version bump and generate CHANGELOG.md files. Make sure your
commits and the title of your PRs follow the spec. A pre-commit hook and CI test
have been added to further enforce this requirement.

## Tips for Getting Your Pull Request Accepted

1. Make sure all new features are tested and the tests pass.
Expand Down

0 comments on commit e9678c4

Please sign in to comment.