First, thank you for contributing to Azure Functions Python Worker repository!
If you would like to become an active contributor to this project, please follow the instructions provided in Microsoft Azure Projects Contribution Guidelines.
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.
If you don't have contributor 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.
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.
You can find all of the pull requests that have been opened in the Pull Request section of the repository.
To open your own pull request, click here. When creating a pull request, keep the following in mind:
- Make sure you are pointing to the fork and branch that your changes were made in (if working from a different fork).
- Choose the correct branch you want your pull request to be merged into.
- 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
- Deleting or ignoring this template will elongate the time it takes for your pull request to be reviewed
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.
If you are thinking about making a large change, break up the change into small, logical, testable chunks, and organize your pull requests accordingly.
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.
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.
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.
For more information on cleaning up the commits in a pull request, such as how to rebase, squash, and cherry-pick, click here.
The following guidelines must be followed in EVERY pull request that is opened.
- Title of the pull request is clear and informative
- There are a small number of commits that each have an informative message
- A description of the changes the pull request makes is included, and a reference to the issue being resolved, if the change address any
- All files have the Microsoft copyright header
The following guidelines must be followed in EVERY pull request that is opened.
- Pull request includes test coverage for the included changes
- Changes would not be merged until all the CI scenarios pass.