Skip to content

Commit 0e232f7

Browse files
vrdmrvrdmr
authored
Updating/Adding github templates, updating CODEOWNERS file. (Azure#656)
1 parent 9e70e3a commit 0e232f7

File tree

5 files changed

+140
-21
lines changed

5 files changed

+140
-21
lines changed

‎.github/CONTRIBUTING.md

+78
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
# Contributing to Azure Functions Python Worker
2+
First, thank you for contributing to Azure Functions Python Worker repository!
3+
4+
## Basics
5+
If you would like to become an active contributor to this project, please follow the instructions provided in [Microsoft Azure Projects Contribution Guidelines](http://azure.github.io/guidelines/).
6+
7+
## Table of Contents
8+
[Before starting](#before-starting)
9+
- [GitHub basics](#github-basics)
10+
- [Code of Conduct](#code-of-conduct)
11+
12+
[Making Changes](#making-changes)
13+
- [Pull Requests](#pull-requests)
14+
- [Pull Request Guidelines](#pull-request-guidelines)
15+
- [Cleaning up commits](#cleaning-up-commits)
16+
- [General guidelines](#general-guidelines)
17+
- [Testing guidelines](#testing-guidelines)
18+
19+
## Before starting
20+
21+
### GitHub basics
22+
23+
#### GitHub workflow
24+
25+
If you don't have experience with Git and GitHub, some of the terminology and process can be confusing. [Here's a guide to understanding GitHub](https://guides.github.com/introduction/flow/).
26+
27+
#### Forking the Azure/Azure-Functions-Python-Worker repository
28+
29+
If you don't have contributor [`Azure/Azure-Functions-Python-Worker`](https://github.com/Azure/azure-functions-python-worker/) repository, we ask that you fork the repository and submit your Pull Request from there. We block PRs from forks to go through E2E tests, however, we will cherry-picked PRs once they pass unit tests to validate the E2E tests. [Here's a guide to forks in GitHub](https://guides.github.com/activities/forking/).
30+
31+
### Code of Conduct
32+
33+
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
34+
35+
## Making Changes
36+
37+
### Pull Requests
38+
39+
You can find all of the pull requests that have been opened in the [Pull Request](https://github.com/Azure/azure-functions-python-worker/pulls) section of the repository.
40+
41+
To open your own pull request, click [here](https://github.com/Azure/azure-functions-python-worker/compare). When creating a pull request, keep the following in mind:
42+
- Make sure you are pointing to the fork and branch that your changes were made in (if working from a different fork).
43+
- Choose the correct branch you want your pull request to be merged into.
44+
- The pull request template that is provided **should be filled out**; this is not something that should just be deleted or ignored when the pull request is created
45+
- Deleting or ignoring this template will elongate the time it takes for your pull request to be reviewed
46+
<!-- - The SLA for reviewing pull requests is **three business days** -->
47+
48+
### Pull Request Guidelines
49+
50+
A pull request template will automatically be included as a part of your PR. Please fill out the checklist as specified. Pull requests **will not be reviewed** unless they include a properly completed checklist.
51+
52+
#### Cleaning up Commits
53+
54+
If you are thinking about making a large change, **break up the change into small, logical, testable chunks, and organize your pull requests accordingly**.
55+
56+
Often when a pull request is created with a large number of files changed and/or a large number of lines of code added and/or removed, GitHub will have a difficult time opening up the changes on their site. This forces the Azure Azure-Functions-Python-Worker team to use separate software to do a code review on the pull request.
57+
58+
If you find yourself creating a pull request and are unable to see all the changes on GitHub, we recommend **splitting the pull request into multiple pull requests that are able to be reviewed on GitHub**.
59+
60+
If splitting up the pull request is not an option, we recommend **creating individual commits for different parts of the pull request, which can be reviewed individually on GitHub**.
61+
62+
For more information on cleaning up the commits in a pull request, such as how to rebase, squash, and cherry-pick, click [here](https://github.com/Azure/azure-powershell/blob/dev/documentation/cleaning-up-commits.md).
63+
64+
#### General guidelines
65+
66+
The following guidelines must be followed in **EVERY** pull request that is opened.
67+
68+
- Title of the pull request is clear and informative
69+
- There are a small number of commits that each have an informative message
70+
- A description of the changes the pull request makes is included, and a reference to the issue being resolved, if the change address any
71+
- All files have the Microsoft copyright header
72+
73+
#### Testing Guidelines
74+
75+
The following guidelines must be followed in **EVERY** pull request that is opened.
76+
77+
- Pull request includes test coverage for the included changes
78+
- Changes would not be merged until all the CI scenarios pass.

‎ISSUE_TEMPLATE.md renamed to ‎.github/ISSUE_TEMPLATE/bug_report.md

+20-21
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,24 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: "[BUG] Bug Title"
5+
---
16

27
<!--
38
Please describe your issue or feature request below.
49
-->
510

6-
#### Investigative information
11+
### Investigative information
12+
###### Please provide the following:
713

8-
Please provide the following:
914

1015
- Timestamp:
1116
- Function App name:
1217
- Function name(s) (as appropriate):
1318
- Core Tools version:
1419

15-
#### Repro steps
16-
17-
Provide the steps required to reproduce the problem:
20+
### Repro steps
21+
###### Provide the steps required to reproduce the problem:
1822

1923
<!--
2024
Example:
@@ -24,39 +28,35 @@ Example:
2428
2529
-->
2630

27-
#### Expected behavior
28-
29-
Provide a description of the expected behavior.
31+
### Expected behavior
32+
###### Provide a description of the expected behavior.
3033

3134
<!--
3235
Example:
3336
3437
- After I perform step B, the lights in the house should turn off.
3538
-->
3639

37-
#### Actual behavior
38-
39-
Provide a description of the actual behavior observed.
40+
### Actual behavior
41+
###### Provide a description of the actual behavior observed.
4042

4143
<!--
4244
Example:
4345
4446
- Step B actually causes my cat to meow for some reason.
4547
-->
4648

47-
#### Known workarounds
48-
49-
Provide a description of any known workarounds.
49+
### Known workarounds
50+
###### Provide a description of any known workarounds.
5051

5152
<!--
5253
Example:
5354
5455
- Turn off the circuit breaker for the lights.
5556
-->
5657

57-
#### Contents of the requirements.txt file:
58-
59-
Provide the requirements.txt file to help us find out module related issues.
58+
### Contents of the requirements.txt file:
59+
###### Provide the requirements.txt file to help us find out module related issues.
6060

6161
<!--
6262
Example:
@@ -67,9 +67,8 @@ azure-storage-blob==12.1.0
6767
```
6868
-->
6969

70-
#### Related information
71-
72-
Provide any related information
70+
### Related information
71+
###### Provide any related information
7372

7473
* Links to source
7574
* Bindings used
@@ -97,4 +96,4 @@ six==1.11.0
9796
```
9897
9998
</details>
100-
-->
99+
-->

‎.github/ISSUE_TEMPLATE/feature_request

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
name: Feature Request
3+
about: Request for a new feature
4+
title: "[FeatureRequest] --Feature Title--"
5+
6+
---
7+
8+
**Describe the request: A clear and concise description.**

‎.github/PULL_REQUEST_TEMPLATE.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
<!-- DO NOT DELETE THIS TEMPLATE -->
2+
3+
## Description
4+
5+
Fixes Issue # <!-- if any -->
6+
<!--
7+
Please add an informative description that covers that changes made by the pull request.
8+
This checklist is used to make sure that common issues in a pull request are addressed.
9+
This will expedite the process of getting your pull request merged and avoid extra work on your part to fix issues discovered during the review process.
10+
-->
11+
12+
---
13+
14+
### PR information
15+
- [ ] The title of the PR is clear and informative.
16+
- [ ] There are a small number of commits, each of which has an informative message. This means that previously merged commits do not appear in the history of the PR. For information on cleaning up the commits in your pull request, [see this page](https://github.com/Azure/azure-powershell/blob/master/documentation/development-docs/cleaning-up-commits.md).
17+
- [ ] If applicable, the PR references the bug/issue that it fixes in the description.
18+
- [ ] New Unit tests were added for the changes made and CI is passing.
19+
<!-- - [ ] Except for special cases involving multiple contributors, the PR is started from a fork of the main repository, not a branch. -->
20+
21+
### Quality of Code and Contribution Guidelines
22+
- [ ] I have read the [contribution guidelines](https://github.com/Azure/azure-functions-python-worker/blob/master/.github/CONTRIBUTING.md).

‎CODEOWNERS

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# See https://help.github.com/articles/about-codeowners/
2+
# for more info about CODEOWNERS file
3+
#
4+
# It uses the same pattern rule for gitignore file
5+
# https://git-scm.com/docs/gitignore#_pattern_format
6+
#
7+
8+
#
9+
# AZURE FUNCTIONS TEAM
10+
# For all file changes, github would automatically include the following people in the PRs.
11+
#
12+
* @anirudhgarg @Hazhzeng @vrdmr

0 commit comments

Comments
 (0)