This repository was archived by the owner on Dec 9, 2024. It is now read-only.
docs: Add contribution guidelines #248
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…rror main Serverless Repo
mydiemho
suggested changes
Aug 17, 2019
.github/ISSUE_TEMPLATE/bug_report.md
Outdated
| --- | ||
|
|
||
| <!-- | ||
| 1. If you have a question and not a bug report please ask first at http://forum.serverless.com |
There was a problem hiding this comment.
even for azure plugin question?
|
|
||
| Welcome, and thanks in advance for your help! Please follow these simple guidelines :+1: | ||
|
|
||
| # How to contribute to the Serverless Azure Plugin |
There was a problem hiding this comment.
also need a section on commit message style guide
pjlittle
reviewed
Aug 19, 2019
.github/ISSUE_TEMPLATE/bug_report.md
Outdated
| <!-- | ||
| 1. If you have a question and not a bug report please ask first at http://forum.serverless.com | ||
| 2. Please check if an issue already exists. This bug may have already been documented | ||
| 3. Check out and follow our Guidelines: https://github.com/serverless/serverless/blob/master/CONTRIBUTING.md |
There was a problem hiding this comment.
We should update this to point to this repo.
pjlittle
reviewed
Aug 19, 2019
|
|
||
| ## Additional Data | ||
|
|
||
| - **_Serverless Framework Version you're using_**: |
There was a problem hiding this comment.
we should also add serverless azure functions plugin version.
There was a problem hiding this comment.
And the version of the Serverless CLI itself
pjlittle
reviewed
Aug 19, 2019
CONTRIBUTING.md
Outdated
|
|
||
| # Testing | ||
|
|
||
| We aim for a (near) 100% test coverage, so make sure your tests cover as much of your code as possible. |
There was a problem hiding this comment.
80%? Targeting 100 seems unrealistic.
pjlittle
reviewed
Aug 19, 2019
CONTRIBUTING.md
Outdated
|
|
||
| # Code Style | ||
|
|
||
| We aim for clean, consistent code style. We're using ESlint to check for codestyle issues using the Airbnb preset. |
There was a problem hiding this comment.
We can remove the reference to Airbnb; we're using eslint typescript recommended settings.
pjlittle
reviewed
Aug 19, 2019
.github/PULL_REQUEST_TEMPLATE.md
Outdated
| @@ -0,0 +1,51 @@ | |||
| <!-- | |||
| 1. Please check out and follow our Contributing Guidelines: https://github.com/serverless/serverless/blob/master/CONTRIBUTING.md | |||
pjlittle
reviewed
Aug 19, 2019
| <!-- | ||
| 1. If you have a question and not a feature request please ask first at http://forum.serverless.com | ||
| 2. Please check if an issue already exists. This feature may have already been requested | ||
| 3. Check out and follow our Guidelines: https://github.com/serverless/serverless/blob/master/CONTRIBUTING.md |
There was a problem hiding this comment.
update this url reference as well
wbreza
approved these changes
Aug 26, 2019
|
|
||
| ## Additional Data | ||
|
|
||
| - **_Serverless Framework Version you're using_**: |
There was a problem hiding this comment.
And the version of the Serverless CLI itself
mydiemho
approved these changes
Aug 28, 2019
.github/PULL_REQUEST_TEMPLATE.md
Outdated
|
|
||
| ## Todos: | ||
|
|
||
| _**Note: Run `npm run test-ci` to run all validation checks on proposed changes**_ |
CONTRIBUTING.md
Outdated
| This results in erratic, jumpy scrolling and a poor user experience. Improve | ||
| stability and usability with debouncing. | ||
|
|
||
| AB#17056 |
There was a problem hiding this comment.
I would use Github issues syntax here, closes #123
CONTRIBUTING.md
Outdated
|
|
||
| # Testing | ||
|
|
||
| We aim for a (near) 80% test coverage, so make sure your tests cover as much of your code as possible. |
There was a problem hiding this comment.
a bit high isn't it? I think 75% is good (that's also the lower limit on our codecov config)
tbarlow12
pushed a commit
that referenced
this pull request
Aug 30, 2019
* Add contribution guidelines and issue/freature request template to mirror main Serverless Repo * Update Readme and pr tempalte * Address pr feedback * Add cli version to bug report * Address last comments
tbarlow12
pushed a commit
that referenced
this pull request
Sep 13, 2019
* Add contribution guidelines and issue/freature request template to mirror main Serverless Repo * Update Readme and pr tempalte * Address pr feedback * Add cli version to bug report * Address last comments
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add contribution guidelines and templates for pull requests, bug reports, and feature requests for the plugin repo. Most of the templates and guides are taken from the core Serverless repo to best match the process put forth there, with minor adjustments to reflect the setup of this repo
AB#805