Skip to content
This repository was archived by the owner on Dec 9, 2024. It is now read-only.

Commit c4ef14a

Browse files
PIC123tbarlow12
PIC123
authored and
tbarlow12
committed
docs: Add contribution guidelines (#248)
* 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
1 parent 1f4a31e commit c4ef14a

File tree

5 files changed

+243
-1
lines changed

5 files changed

+243
-1
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
---
5+
6+
<!--
7+
1. Please check if an issue already exists. This bug may have already been documented
8+
2. Check out and follow our Guidelines: https://github.com/serverless/serverless-azure-functions/CONTRIBUTING.md
9+
3. Fill out the whole template so we have a good overview on the issue
10+
4. Do not remove any section of the template. If something is not applicable leave it empty but leave it in the Issue
11+
5. Please follow the template, otherwise we'll have to ask you to update it
12+
-->
13+
14+
# This is a Bug Report
15+
16+
## Description
17+
18+
- What went wrong?
19+
- What did you expect should have happened?
20+
- What was the config you used?
21+
- What stacktrace or error message from your provider did you see?
22+
23+
Similar or dependent issues:
24+
25+
- #12345
26+
27+
## Additional Data
28+
29+
- **_Serverless Framework Version you're using_**:
30+
- **_Serverless CLI Version you're using_**:
31+
- **_Serverless Azure Plugin Version you're using_**:
32+
- **_Operating System_**:
33+
- **_Stack Trace_**:
34+
- **_Provider Error messages_**:

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for serverless framework
4+
---
5+
6+
<!--
7+
1. Please check if an issue already exists. This feature may have already been requested
8+
2. Check out and follow our Guidelines: https://github.com/serverless/serverless-azure-functions/CONTRIBUTING.md
9+
3. Fill out the whole template so we have a good overview on the issue
10+
4. Do not remove any section of the template. If something is not applicable leave it empty but leave it in the Issue
11+
5. Please follow the template, otherwise we'll have to ask you to update it
12+
-->
13+
14+
# This is a Feature Proposal
15+
16+
## Description
17+
18+
- What is the use case that should be solved. The more detail you describe this in the easier it is to understand for us.
19+
- If there is additional config how would it look
20+
21+
Similar or dependent issues:
22+
23+
- #12345

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
<!--
2+
1. Please check out and follow our Contributing Guidelines: https://github.com/serverless/serverless-azure-functions/CONTRIBUTING.md
3+
2. Do not remove any section of the template. If something is not applicable leave it empty but leave it in the PR
4+
3. Please follow the template, otherwise we'll have to ask you to update it and it will take longer until your PR is merged
5+
-->
6+
7+
## What did you implement:
8+
9+
Closes #XXXXX
10+
11+
<!--
12+
Briefly describe the feature if no issue exists for this PR
13+
-->
14+
15+
## How did you implement it:
16+
17+
<!--
18+
If this is a nontrivial change please briefly describe your implementation so its easy for us to understand and review your code.
19+
-->
20+
21+
## How can we verify it:
22+
23+
<!--
24+
Add any applicable config, commands, screenshots or other resources
25+
to make it easy for us to verify this works. The easier you make it for us
26+
to review a PR, the faster we can review and merge it.
27+
28+
Examples:
29+
* serverless.yml - Fully functioning to easily deploy changes
30+
* Screenshots - Showing the difference between your output and the master
31+
* Cloud Configuration - List cloud resources and show that the correct configuration is in place (e.g. AWS CLI commands)
32+
* Other - Anything else that comes to mind to help us evaluate
33+
-->
34+
35+
## Todos:
36+
37+
_**Note: Run `npm run test:ci` to run all validation checks on proposed changes**_
38+
39+
- [ ] Write tests and confirm existing functionality is not broken.
40+
**Validate via `npm test`**
41+
- [ ] Write documentation
42+
- [ ] Ensure there are no lint errors.
43+
**Validate via `npm run lint`**
44+
_Note: Some reported issues can be automatically fixed by running `npm run lint:fix`_
45+
- [ ] Make sure code coverage hasn't dropped
46+
- [ ] Provide verification config / commands / resources
47+
- [ ] Enable "Allow edits from maintainers" for this PR
48+
- [ ] Update the messages below
49+
50+
**_Is this ready for review?:_** NO
51+
**_Is it a breaking change?:_** NO

‎CONTRIBUTING.md‎

Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
# Contributing Guidelines
2+
3+
Welcome, and thanks in advance for your help! Please follow these simple guidelines :+1:
4+
5+
# How to contribute to the Serverless Azure Plugin
6+
7+
## When you propose a new feature or bug fix
8+
9+
**Note:** Please make sure to write an issue first and get enough feedback before jumping into a Pull Request!
10+
11+
- Please make sure there is an open issue discussing your contribution
12+
- If there isn't, please open an issue so we can talk about it before you invest time into the implementation
13+
- When creating an issue or pull request, follow the template that GitHub shows so that we have enough information about your request
14+
15+
## When you want to work on an existing issue
16+
17+
**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.
18+
19+
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.
20+
21+
## Reviewing Pull Requests
22+
23+
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.
24+
25+
## Writing / improving documentation
26+
27+
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!
28+
29+
## Providing support
30+
31+
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.
32+
33+
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).
34+
35+
### Commit Message Format
36+
37+
Each commit message consists of a **header**, a **body** and a **footer**.
38+
39+
```text
40+
<type>: <short description>
41+
<BLANK LINE>
42+
<body>
43+
<BLANK LINE>
44+
<footer>
45+
```
46+
47+
### Header
48+
49+
#### Type
50+
51+
Must be one of the following:
52+
53+
* **build**: Changes that affect the build system or external dependencies
54+
* **ci**: Changes to our CI configuration files and scripts
55+
* **docs**: Documentation only changes
56+
* **feat**: A new feature
57+
* **fix**: A bug fix
58+
* **perf**: A code change that improves performance
59+
* **refactor**: A code change that neither fixes a bug nor adds a feature
60+
* **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
61+
* **test**: Adding missing tests or correcting existing tests
62+
* **chore**: Updating dependencies
63+
64+
#### Short Description
65+
66+
Contains a succinct description of the change:
67+
68+
* use the imperative, present tense: "change" not "changed" nor "changes"
69+
* don't capitalize the first letter
70+
* no dot (.) at the end
71+
72+
### Body
73+
74+
Just as in the **short description**, use the imperative, present tense: "change" not "changed" nor "changes".
75+
The body should include the motivation for the change and contrast this with previous behavior.
76+
77+
### Footer
78+
79+
The footer should contain any information about **breaking changes** and is also the place to
80+
reference Azure DevOps user stories/tasks or GitHub issues that this commit **closes**.
81+
82+
### Commit Message Example
83+
84+
```text
85+
fix: add debouncing to asset scroller to correct browser scroll position
86+
87+
There is no debouncing when we store the asset container's scroll position.
88+
This results in erratic, jumpy scrolling and a poor user experience. Improve
89+
stability and usability with debouncing.
90+
91+
closes #123
92+
```
93+
94+
---
95+
96+
# Code Style
97+
98+
We aim for clean, consistent code style. We're using ESlint to check for codestyle issues.
99+
100+
## Verifying linting style
101+
102+
```
103+
npm run lint
104+
```
105+
106+
## Fixing lint issues
107+
108+
```
109+
npm run lint:fix
110+
```
111+
112+
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.
113+
114+
# Testing
115+
116+
We aim for a (near) 75% test coverage, so make sure your tests cover as much of your code as possible.
117+
118+
## Test coverage
119+
120+
During development, you can easily check coverage by running `npm test`.
121+
122+
Please follow these Testing guidelines when writing your unit tests:
123+
124+
- Include a top-level `describe('ClassName')` block, with the name of the class you are testing
125+
- Inside that top-level `describe()` block, create another `describe('#methodOne()')` block for each class method you might create or modify
126+
- For each method, include an `it('should do something')` test case for each logical edge case in your changes
127+
- 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
128+
- For reference and inspiration, please check our `tests` directory
129+
130+
---
131+
132+
Thanks again for being a contributor to the Serverless Community :tada:!
133+
134+
Thanks!

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@ The getting started walkthrough illustrates the interactive login experience, wh
207207

208208
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.
209209

210-
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.
210+
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.
211211
212212
#### Local dev
213213

0 commit comments

Comments
 (0)