Skip to content

Commit

Permalink
Update issue/pr templates and contributing guide
Browse files Browse the repository at this point in the history
  • Loading branch information
flomotlik committed Sep 5, 2016
1 parent 49de850 commit 17bc185
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 17 deletions.
17 changes: 8 additions & 9 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<!--
1. Please check if an issue already exists so there are no duplicates
2. Check out and follow our Guidelines: https://github.com/serverless/serverless/blob/master/CONTRIBUTING.md
2. Fill out the whole template so we have a good overview on the issue
3. Please follow the template, otherwise we'll have to ask you to update it
4. Remove any template data that isn't necessary for your issue
3. Fill out the whole template so we have a good overview on the issue
4. Do not remove any section of the template. If something is not applicable leave it empty but leave it in the Issue
5. Please follow the template, otherwise we'll have to ask you to update it
-->

# This is a (Bug Report / Feature Proposal)
Expand All @@ -17,16 +17,15 @@ For bug reports:
* What stacktrace or error message from your provider did you see?

For feature proposals:
* What is the use case that should be solved
* What is the use case that should be solved. The more detail you describe this in the easier it is to understand for us.
* If there is additional config how would it look
* Which command should this be running for

Similar or dependent issues:
* #12345

## Additional Data

* ***Serverless Framework Version you're using:***
* ***Operating System:***
* ***Stack Trace:***
* ***Provider Error messages:***
* ***Serverless Framework Version you're using***:
* ***Operating System***:
* ***Stack Trace***:
* ***Provider Error messages***:
12 changes: 8 additions & 4 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,22 @@
<!--
1. Please check out and follow our Contributing Guidelines: https://github.com/serverless/serverless/blob/master/CONTRIBUTING.md
2. Fill out the whole template so we have a good overview on the issue
3. Do not remove any section of the template. If something is not applicable leave it empty but leave it in the PR
3. Please follow the template, otherwise we'll have to ask you to update it
-->

***Implementing Issue:*** #12345

## What did you implement:

***Implementing Issue:*** #12345

<!--
Briefly describe the feature
Briefly describe the feature if no issue exists for this PR
-->

## How did you implement it:

<!--
If this is a nontrivial change please briefly describe your implementation.
If this is a nontrivial change please briefly describe your implementation so its easy for us to understand and review your code.
-->

## How can we verify it:
Expand All @@ -30,5 +31,8 @@ or AWS CLI commands to trigger something.
## Todos:

- [ ] Write tests
- [ ] Write documentation
- [ ] Fix linting errors
- [ ] Make sure code coverage hasn't dropped
- [ ] Provide verification config/commands/resources
- [ ] Leave a comment that this is ready for review once you've finished the implementation
6 changes: 2 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,19 +17,17 @@ In there you will find different issues that we think are important and need som

## Pull Requests
Please follow these Pull Request guidelines when creating Pull Requests:
* If an Issue exists, mention in there that you are working on a solution.
* If an Issue exists, leave a comment there that you are working on a solution so nobody else jumps on it.
* If an Issue does not exist, create a new Issue, detail your changes. We recommend waiting until we accept it, so you don't waste your precious time.
* Follow our **Testing** and **Code Style** guidelines below.
* Squash multiple commits into a single commit via `git rebase -i`.
* Start commit messages with a lowercase verb such as "add", "fix", "refactor", "remove".
* Submit your PR and make sure the Travis-CI builds don't fail.
* Submit your PR and make sure the Travis-CI builds don't fail and the code coverage isn't lowered.
* Reference the issue in your PR.

## Issues
Please follow these Issue guidelines for opening Issues:
* Make sure your Issue is not a duplicate.
* Make sure your Issue is for a *feature request*, *bug report*, or *a discussion about a relevant topic*. For everything else, please use our [Discourse Forum](http://forum.serverless.com)
* Add the relevant Issue Label(s) and together we will keep them updated.

### Code Style
We aim for clean, consistent code style. We're using ESlint to check for codestyle issues using the Airbnb preset. If ESlint issues are found our build will fail and we can't merge the PR.
Expand Down

0 comments on commit 17bc185

Please sign in to comment.