-
Notifications
You must be signed in to change notification settings - Fork 78
Update CONTRIBUTING, support Py3.11 #210
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,18 +1,87 @@ | ||
| # Azure Monitor Contributing Guide | ||
|
|
||
| TODO | ||
| This project welcomes contributions and suggestions. Most contributions require you to agree to a | ||
| Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us | ||
| the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com. | ||
|
|
||
| When you submit a pull request, a CLA bot will automatically determine whether you need to provide | ||
| a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions | ||
| provided by the bot. You will only need to do this once across all repos using our CLA. | ||
|
|
||
| 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. | ||
|
|
||
| ## Reporting Bugs/Feature Requests | ||
|
|
||
| TODO | ||
| To report a bug or feature request, open up an [issue](https://github.com/microsoft/ApplicationInsights-Python/issues). Please provide as much information as possible. For a bug, describe your environment, provide steps to reproduce, expected behavior/actual behavior in the description, etc. | ||
|
|
||
| ## Contributing | ||
|
|
||
| TODO | ||
| Everyone is welcome to contribute code to this repository via GitHub | ||
| pull requests (PRs). | ||
|
|
||
| To create a new PR, fork the project in GitHub and clone the upstream repo: | ||
|
|
||
| ```console | ||
| $ git clone https://github.com/microsoft/ApplicationInsights-Python.git | ||
| ``` | ||
|
|
||
| Add your fork as an origin: | ||
|
|
||
| ```console | ||
| $ git remote add fork https://github.com/YOUR_GITHUB_USERNAME/microsoft/ApplicationInsights-python.git | ||
| ``` | ||
|
|
||
| Run tests: | ||
|
|
||
| ```sh | ||
| # make sure you have all supported versions of Python installed | ||
| $ pip install tox # only first time. | ||
| $ tox # execute in the root of the repository | ||
| ``` | ||
|
|
||
| Check out a new branch, make modifications and push the branch to your fork: | ||
|
|
||
| ```sh | ||
| $ git checkout -b feature | ||
| # edit files | ||
| $ git commit | ||
| $ git push fork feature | ||
| ``` | ||
|
|
||
| Open up a pull request with your changes. | ||
|
|
||
| ## Development | ||
|
|
||
| TODO | ||
| This project uses [tox](https://tox.readthedocs.io) to automate | ||
| some aspects of development, including testing against multiple Python versions. | ||
| To install `tox`, run: | ||
|
|
||
| ```console | ||
| $ pip install tox | ||
| ``` | ||
|
|
||
| We will use the Azure Monitor distro project as an example. | ||
| You can run `tox` with the following arguments: | ||
|
|
||
| - `tox` to run all existing tox commands, including unit tests for all packages | ||
| under multiple Python versions | ||
| - `tox -e distro` to run the unit tests | ||
| - `tox -e py310-distro` to e.g. run the API unit tests under a specific | ||
| Python version | ||
| - `tox -e spellcheck` to run a spellcheck on all the code | ||
| - `tox -e lint` to run lint checks on all code | ||
|
|
||
| `black` and `isort` are executed when `tox -e lint` is run. The reported errors can be tedious to fix manually. | ||
| An easier way to do so is: | ||
|
|
||
| 1. Run `.tox/lint/bin/black .` | ||
| 2. Run `.tox/lint/bin/isort .` | ||
|
|
||
| See | ||
| [`tox.ini`](https://github.com/microsoft/ApplicationInsights-Python/blob/main/tox.ini) | ||
| for more detail on available tox commands. | ||
|
|
||
| ## Documentation | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.