From ff53244645b61f4b0a748cafe762af548c554c82 Mon Sep 17 00:00:00 2001 From: Phil Cherner Date: Fri, 16 Aug 2019 16:18:58 -0700 Subject: [PATCH 1/5] Add contribution guidelines and issue/freature request template to mirror main Serverless Repo --- .github/ISSUE_TEMPLATE/bug_report.md | 33 ++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 24 +++++++ .github/PULL_REQUEST_TEMPLATE.md | 54 ++++++++++++++++ CONTRIBUTING.md | 76 +++++++++++++++++++++++ 4 files changed, 187 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 CONTRIBUTING.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..7dc59f59 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,33 @@ +--- +name: Bug report +about: Create a report to help us improve +--- + + + +# This is a Bug Report + +## Description + +- What went wrong? +- What did you expect should have happened? +- What was the config you used? +- What stacktrace or error message from your provider did you see? + +Similar or dependent issues: + +- #12345 + +## Additional Data + +- **_Serverless Framework Version you're using_**: +- **_Operating System_**: +- **_Stack Trace_**: +- **_Provider Error messages_**: diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..5c520999 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,24 @@ +--- +name: Feature request +about: Suggest an idea for serverless framework +--- + + + +# This is a Feature Proposal + +## Description + +- 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 + +Similar or dependent issues: + +- #12345 diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..4d9bf3c4 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,54 @@ + + +## What did you implement: + +Closes #XXXXX + + + +## How did you implement it: + + + +## How can we verify it: + + + +## Todos: + +_**Note: Run `npm run test-ci` to run all validation checks on proposed changes**_ + +- [ ] Write tests and confirm existing functionality is not broken. + **Validate via `npm test`** +- [ ] Write documentation +- [ ] Ensure there are no lint errors. + **Validate via `npm run lint-updated`** + _Note: Some reported issues can be automatically fixed by running `npm run lint:fix`_ +- [ ] Ensure introduced changes match Prettier formatting. + **Validate via `npm run prettier-check-updated`** + _Note: All reported issues can be automatically fixed by running `npm run prettify-updated`_ +- [ ] Make sure code coverage hasn't dropped +- [ ] Provide verification config / commands / resources +- [ ] Enable "Allow edits from maintainers" for this PR +- [ ] Update the messages below + +**_Is this ready for review?:_** NO +**_Is it a breaking change?:_** NO diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..a28ec79c --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,76 @@ +# Contributing Guidelines + +Welcome, and thanks in advance for your help! Please follow these simple guidelines :+1: + +# How to contribute to the Serverless Azure Plugin + +## When you propose a new feature or bug fix + +**Note:** Please make sure to write an issue first and get enough feedback before jumping into a Pull Request! + +- Please make sure there is an open issue discussing your contribution +- If there isn't, please open an issue so we can talk about it before you invest time into the implementation +- When creating an issue or pull request, follow the template that GitHub shows so that we have enough information about your request + +## When you want to work on an existing issue + +**Note:** Please write a quick comment in the corresponding issue and ask if the feature is still relevant and that you want to jump into the implementation. + +We will do our best to respond/review/merge your PR according to priority. We hope that you stay engaged with us during this period to insure QA. Please note that the PR will be closed if there hasn't been any activity for a long time (~ 30 days) to keep us focused and keep the repo clean. + +## Reviewing Pull Requests + +Another really useful way to contribute to Serverless is to review other peoples Pull Requests. Having feedback from multiple people is really helpful and reduces the overall time to make a final decision about the Pull Request. + +## Writing / improving documentation + +Our documentation lives on GitHub in the [docs](docs) directory. Do you see a typo or other ways to improve it? Feel free to edit it and submit a Pull Request! + +## Providing support + +The easiest thing you can do to help us move forward and make an impact on our progress is to simply provide support to other people having difficulties with their Serverless projects. + +You can do that by replying to [issues on Github](https://github.com/serverless/serverless-azure-functions/issues), chatting with other community members in [our Chat](http://chat.serverless.com) or helping with questions in [our Forum](http://forum.serverless.com). + + +--- + +# Code Style + +We aim for clean, consistent code style. We're using ESlint to check for codestyle issues using the Airbnb preset. + +## Verifying linting style + +``` +npm run lint +``` + +## Fixing lint issues + +``` +npm run lint:fix +``` + +To help reduce the effort of creating contributions with this style, an [.editorconfig file](http://editorconfig.org/) is provided that your editor may use to override any conflicting global defaults and automate a subset of the style settings. + +# Testing + +We aim for a (near) 100% test coverage, so make sure your tests cover as much of your code as possible. + +## Test coverage + +During development, you can easily check coverage by running `npm test`. + +Please follow these Testing guidelines when writing your unit tests: + +- Include a top-level `describe('ClassName')` block, with the name of the class you are testing +- Inside that top-level `describe()` block, create another `describe('#methodOne()')` block for each class method you might create or modify +- For each method, include an `it('should do something')` test case for each logical edge case in your changes +- As you write tests, check the code coverage and make sure all lines of code are covered. If not, just add more test cases until everything is covered +- For reference and inspiration, please check our `tests` directory + +--- + +Thanks again for being a contributor to the Serverless Community :tada:! + +Thanks! \ No newline at end of file From 6bd2120511d3a4da6fef5b6aaf30f88f088178f4 Mon Sep 17 00:00:00 2001 From: Phil Cherner Date: Fri, 16 Aug 2019 16:29:41 -0700 Subject: [PATCH 2/5] Update Readme and pr tempalte --- .github/PULL_REQUEST_TEMPLATE.md | 5 +---- README.md | 2 +- 2 files changed, 2 insertions(+), 5 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 4d9bf3c4..b3962ae1 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -40,11 +40,8 @@ _**Note: Run `npm run test-ci` to run all validation checks on proposed changes* **Validate via `npm test`** - [ ] Write documentation - [ ] Ensure there are no lint errors. - **Validate via `npm run lint-updated`** + **Validate via `npm run lint`** _Note: Some reported issues can be automatically fixed by running `npm run lint:fix`_ -- [ ] Ensure introduced changes match Prettier formatting. - **Validate via `npm run prettier-check-updated`** - _Note: All reported issues can be automatically fixed by running `npm run prettify-updated`_ - [ ] Make sure code coverage hasn't dropped - [ ] Provide verification config / commands / resources - [ ] Enable "Allow edits from maintainers" for this PR diff --git a/README.md b/README.md index cd669a08..1e359c29 100644 --- a/README.md +++ b/README.md @@ -207,7 +207,7 @@ The getting started walkthrough illustrates the interactive login experience, wh Please create issues in this repo for any problems or questions you find. Before sending a PR for any major changes, please create an issue to discuss. -We're still in the process of getting everying running 100%, but please refer to the [Serverless contributing guidlines](https://github.com/serverless/serverless/blob/master/CONTRIBUTING.md) for information on how to contribute and code of conduct. +We're still in the process of getting everying running 100%, but please refer to the [Serverless contributing guidlines](CONTRIBUTING.md) for information on how to contribute and code of conduct. #### Local dev From dff9820c9cdf1c569959d5644dbdadcac20bed6f Mon Sep 17 00:00:00 2001 From: Phil Cherner Date: Mon, 19 Aug 2019 10:35:29 -0700 Subject: [PATCH 3/5] Address pr feedback --- .github/ISSUE_TEMPLATE/bug_report.md | 12 ++--- .github/ISSUE_TEMPLATE/feature_request.md | 11 ++-- .github/PULL_REQUEST_TEMPLATE.md | 2 +- CONTRIBUTING.md | 61 ++++++++++++++++++++++- 4 files changed, 71 insertions(+), 15 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 7dc59f59..acbd1f11 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -4,12 +4,11 @@ about: Create a report to help us improve --- # This is a Bug Report @@ -28,6 +27,7 @@ Similar or dependent issues: ## Additional Data - **_Serverless Framework Version you're using_**: +- **_Serverless Azure Plugin Version you're using_**: - **_Operating System_**: - **_Stack Trace_**: - **_Provider Error messages_**: diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 5c520999..4e19c597 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -4,12 +4,11 @@ about: Suggest an idea for serverless framework --- # This is a Feature Proposal diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index b3962ae1..e2731b4a 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,5 +1,5 @@ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a28ec79c..2647293d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -32,12 +32,69 @@ The easiest thing you can do to help us move forward and make an impact on our p You can do that by replying to [issues on Github](https://github.com/serverless/serverless-azure-functions/issues), chatting with other community members in [our Chat](http://chat.serverless.com) or helping with questions in [our Forum](http://forum.serverless.com). +### Commit Message Format + +Each commit message consists of a **header**, a **body** and a **footer**. + +```text +: + + + +