Skip to content

Commit

Permalink
Merge branch 'main' into feature/distutils-docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jaraco committed Apr 25, 2021
2 parents 8b49463 + b5fa6ad commit 4d7a11e
Show file tree
Hide file tree
Showing 99 changed files with 2,883 additions and 1,767 deletions.
2 changes: 1 addition & 1 deletion .bumpversion.cfg
@@ -1,5 +1,5 @@
[bumpversion]
current_version = 50.3.2
current_version = 56.0.0
commit = True
tag = True

Expand Down
9 changes: 4 additions & 5 deletions .coveragerc
@@ -1,8 +1,7 @@
[run]
source=
pkg_resources
setuptools
omit=
*/_vendor/*
omit =
# leading `*/` for pytest-dev/pytest-cov#456
*/.tox/*

[report]
show_missing = True
15 changes: 15 additions & 0 deletions .editorconfig
@@ -0,0 +1,15 @@
root = true

[*]
charset = utf-8
indent_style = tab
indent_size = 4
insert_final_newline = true
end_of_line = lf

[*.py]
indent_style = space

[*.{yml,yaml}]
indent_style = space
indent_size = 2
25 changes: 14 additions & 11 deletions .flake8
@@ -1,12 +1,15 @@
[flake8]
exclude=
.tox
setuptools/_vendor,
pkg_resources/_vendor
ignore =
# W503 violates spec https://github.com/PyCQA/pycodestyle/issues/513
W503
# W504 has issues https://github.com/OCA/maintainer-quality-tools/issues/545
W504
setuptools/site-patch.py F821
setuptools/py*compat.py F811
max-line-length = 88

# jaraco/skeleton#34
max-complexity = 10

extend-exclude =
build
setuptools/_vendor
setuptools/_distutils
pkg_resources/_vendor

extend-ignore =
# Black creates whitespace before colon
E203
129 changes: 129 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
@@ -0,0 +1,129 @@
---
name: 🐛 Bug report
description: >-
Create a report to help us improve when
something is not working correctly
title: '[BUG] '
labels:
- bug
- Needs Triage

body:
- type: markdown
attributes:
value: >
**Thank you for wanting to report a bug in setuptools!**
Verify first that your issue is not
[already reported on GitHub][issue search] and keep in mind and
keep in mind that we may have to keep the current behavior because
[every change breaks someone's workflow][XKCD 1172].
We try to be mindful about this.
Also test if the latest release and main branch are affected too.
If you are seeking community support, please consider
[starting a discussion][Discussions].
Thank you for your collaboration!
[Discussions]: https://github.com/pypa/setuptools/discussions
[issue search]: https://github.com/pypa/setuptools/search?q=is%3Aissue&type=issues
[XKCD 1172]: https://xkcd.com/1172/
- type: markdown
attributes:
value: >-
**Environment**
- type: input
attributes:
label: setuptools version
placeholder: For example, setuptools===60.4.2
validations:
required: true
- type: input
attributes:
label: Python version
placeholder: For example, Python 3.10
validations:
required: true
- type: input
attributes:
label: OS
placeholder: For example, Gentoo Linux, RHEL 8, Arch Linux, macOS etc.
validations:
required: true
- type: textarea
attributes:
label: Additional environment information
description: >-
Feel free to add more information about your environment here.
placeholder: >-
This is only happening when I run setuptools on my fridge's patched firmware 🤯
- type: textarea
attributes:
label: Description
description: >-
A clear and concise description of what the bug is.
placeholder: >-
I tried doing X and I expected it to result in Y because the docs
mentioned Z but what happened next what totally unexpected!
And here's why...
validations:
required: true

- type: textarea
attributes:
label: Expected behavior
description: >-
A clear and concise description of what you expected to happen.
placeholder: >-
I tried doing X and I expected it to result in Y. I'm confused...
validations:
required: true

- type: textarea
attributes:
label: How to Reproduce
description: >-
Describe the steps to reproduce this bug.
placeholder: |
1. Integrate setuptools via '...'
2. Then run '...'
3. An error occurs.
validations:
required: true

- type: textarea
attributes:
label: Output
description: >-
Paste the output of the steps above, including the commands
themselves and setuptools' output/traceback etc.
value: |
```console
```
validations:
required: true


- type: checkboxes
attributes:
label: Code of Conduct
description: |
Read the [PSF Code of Conduct][CoC] first.
[CoC]: https://github.com/pypa/.github/blob/main/CODE_OF_CONDUCT.md
options:
- label: I agree to follow the PSF Code of Conduct
required: true
...
15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,15 @@
# Ref: https://help.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
blank_issues_enabled: false # default: true
contact_links:
- name: 🤔 Have questions or need support?
url: https://github.com/pypa/setuptools/discussions
about: This is a place for the community to exchange ideas and recipes
- name: 💬 Discourse
url: https://discuss.python.org/c/packaging
about: |
Please ask typical Q&A here: general ideas for Python packaging,
questions about structuring projects and so on
- name: >-
💬 IRC: #pypa @ Freenode
url: https://webchat.freenode.net/#pypa
about: Chat with devs
91 changes: 91 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation-report.yml
@@ -0,0 +1,91 @@
---
name: 📝 Documentation Report
title: '[Docs] '
description: Ask us about docs
labels:
- documentation
- Needs Triage

body:
- type: markdown
attributes:
value: >
**Thank you for wanting to report a problem with setuptools
documentation!**
Please fill out your suggestions below. If the problem seems
straightforward, feel free to go ahead and
submit a pull request instead!
Verify first that your issue is not [already reported on
GitHub][issue search].
If you are seeking community support, please consider
[starting a discussion][Discussions].
Thank you for your collaboration!
[issue search]: https://github.com/pypa/setuptools/search?q=is%3Aissue&type=issues
[Discussions]: https://github.com/pypa/setuptools/discussions
- type: textarea
attributes:
label: Summary
description: >
Explain the problem briefly below, add suggestions to wording
or structure.
**HINT:** Did you know the documentation has a `View on GitHub`
link on every page? Feel free to use it to start a pull request
right from the GitHub UI!
placeholder: >-
I was reading the setuptools documentation of version X and I'm
having problems understanding Y. It would be very helpful if that
got rephrased as Z.
validations:
required: true

- type: textarea
attributes:
label: OS / Environment
description: >-
Provide all relevant information below, e.g. OS version,
browser, etc.
placeholder: Fedora 33, Firefox etc.


- type: textarea
attributes:
label: Additional Information
description: >
Describe how this improves the documentation, e.g. before/after
situation or screenshots.
**HINT:** You can paste https://gist.github.com links for larger files.
placeholder: >-
When the improvement is applied, it makes it more straightforward
to understand X.
validations:
required: true


- type: checkboxes
attributes:
label: Code of Conduct
description: |
Read the [PSF Code of Conduct][CoC] first.
[CoC]: https://github.com/pypa/.github/blob/main/CODE_OF_CONDUCT.md
options:
- label: I agree to follow the PSF Code of Conduct
required: true
...

0 comments on commit 4d7a11e

Please sign in to comment.