Skip to content

Commit

Permalink
Create PULL_REQUEST_TEMPLATE.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Salamek authored Jan 10, 2018
1 parent 07ef939 commit e81371d
Showing 1 changed file with 65 additions and 0 deletions.
65 changes: 65 additions & 0 deletions PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
Hello, and thanks for contributing to PplMyApi

## tldr

There are two main goals in this document, depending on the nature of your PR:

- [description](#description): please tell us about your pr
- [checklist](#checklist): please review the checklist that is most closly related to your PR

The following sections provide more detail on each.

**Improve this document**

Please don't hesitate to [ask questions][issues] for clarification, or to [make suggestions][issues] (or a pull request) to improve this document.

## Description

To help the project's maintainers and community to quickly understand the nature of your pull requeset, please create a description that incorporates the following elements:

- [ ] what is accomplished by the PR
- [ ] if there is something potentially controversial in your PR, please take a moment to tell us about your choices

## Checklist

Please use the checklist that is most closely related to your PR _(you only need to use one checklist, and you can skip items that aren't applicable or don't make sense)_:

- [fixing typos]()
- [documentation]()
- [bug fix]()
- [new feature]()
- [other]()

### Fixing typos

- [ ] Please review the [readme advice]() section before submitting changes

### Documentation

- [ ] Please review the [readme advice](#readme-advice) section before submitting changes

### Bug Fix

- [ ] All existing unit tests are still passing (if applicable)
- [ ] Add new passing unit tests to cover the code introduced by your PR
- [ ] Update the readme (see [readme advice](#readme-advice))
- [ ] Update or add any necessary API documentation

### New Feature

- [ ] If this is a big feature with breaking changes, consider [opening an issue][issues] to discuss first. This is completely up to you, but please keep in mind that your pr might not be accepted.
- [ ] Run unit tests to ensure all existing tests are still passing
- [ ] Add new passing unit tests to cover the code introduced by your PR
- [ ] Update the readme (see [readme advice](#readme-advice))

Thanks for contributing!

## Readme advice

Please review this section if you are updating readme documentation.

**Code comments**

Please add code comments (following the same style as existing comments) to describe any code changes or new code introduced by your pull request.

[issues]: ../../issues

0 comments on commit e81371d

Please sign in to comment.