Sitelet https://github.com/dbraham/serverless/commit/17bc1856ffed423c644e1bbb89aa58e6aca641b4
Skip to content

Commit 17bc185

Browse files
committed
Update issue/pr templates and contributing guide
1 parent 49de850 commit 17bc185

3 files changed

Lines changed: 18 additions & 17 deletions

File tree

‎.github/ISSUE_TEMPLATE.md‎

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
<!--
22
1. Please check if an issue already exists so there are no duplicates
33
2. Check out and follow our Guidelines: https://github.com/serverless/serverless/blob/master/CONTRIBUTING.md
4-
2. Fill out the whole template so we have a good overview on the issue
5-
3. Please follow the template, otherwise we'll have to ask you to update it
6-
4. Remove any template data that isn't necessary for your issue
4+
3. Fill out the whole template so we have a good overview on the issue
5+
4. Do not remove any section of the template. If something is not applicable leave it empty but leave it in the Issue
6+
5. Please follow the template, otherwise we'll have to ask you to update it
77
-->
88

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

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

2423
Similar or dependent issues:
2524
* #12345
2625

2726
## Additional Data
2827

29-
* ***Serverless Framework Version you're using:***
30-
* ***Operating System:***
31-
* ***Stack Trace:***
32-
* ***Provider Error messages:***
28+
* ***Serverless Framework Version you're using***:
29+
* ***Operating System***:
30+
* ***Stack Trace***:
31+
* ***Provider Error messages***:

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,22 @@
11
<!--
22
1. Please check out and follow our Contributing Guidelines: https://github.com/serverless/serverless/blob/master/CONTRIBUTING.md
33
2. Fill out the whole template so we have a good overview on the issue
4+
3. Do not remove any section of the template. If something is not applicable leave it empty but leave it in the PR
45
3. Please follow the template, otherwise we'll have to ask you to update it
56
-->
67

7-
***Implementing Issue:*** #12345
8-
98
## What did you implement:
109

10+
***Implementing Issue:*** #12345
11+
1112
<!--
12-
Briefly describe the feature
13+
Briefly describe the feature if no issue exists for this PR
1314
-->
1415

1516
## How did you implement it:
1617

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

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

3233
- [ ] Write tests
34+
- [ ] Write documentation
3335
- [ ] Fix linting errors
36+
- [ ] Make sure code coverage hasn't dropped
3437
- [ ] Provide verification config/commands/resources
38+
- [ ] Leave a comment that this is ready for review once you've finished the implementation

‎CONTRIBUTING.md‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,19 +17,17 @@ In there you will find different issues that we think are important and need som
1717

1818
## Pull Requests
1919
Please follow these Pull Request guidelines when creating Pull Requests:
20-
* If an Issue exists, mention in there that you are working on a solution.
20+
* If an Issue exists, leave a comment there that you are working on a solution so nobody else jumps on it.
2121
* 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.
2222
* Follow our **Testing** and **Code Style** guidelines below.
23-
* Squash multiple commits into a single commit via `git rebase -i`.
2423
* Start commit messages with a lowercase verb such as "add", "fix", "refactor", "remove".
25-
* Submit your PR and make sure the Travis-CI builds don't fail.
24+
* Submit your PR and make sure the Travis-CI builds don't fail and the code coverage isn't lowered.
2625
* Reference the issue in your PR.
2726

2827
## Issues
2928
Please follow these Issue guidelines for opening Issues:
3029
* Make sure your Issue is not a duplicate.
3130
* 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)
32-
* Add the relevant Issue Label(s) and together we will keep them updated.
3331

3432
### Code Style
3533
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.

0 commit comments

Comments
 (0)