diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..9bff114f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,34 @@ +--- +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_**: +- **_Serverless CLI 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 new file mode 100644 index 00000000..4e19c597 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,23 @@ +--- +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..dc53426d --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,51 @@ + + +## 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`** + _Note: Some reported issues can be automatically fixed by running `npm run lint:fix`_ +- [ ] 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..fffd923e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,134 @@ +# 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). + +### Commit Message Format + +Each commit message consists of a **header**, a **body** and a **footer**. + +```text +: + + + +