Skip to content

Commit 7c729de

Browse files
authored
♻️ refactor(project): apply the house style (#459)
House-style drift spanned 137 tracked files across the Python and Rust workspace, from broad APIs and duplicate tests to stale contributor guidance. Issue templates needed the same pass. The refactor narrows public Python APIs, consolidates duplicate test scaffolding, shortens Rust data paths, and replaces partial assertions with whole-result checks without changing formatter output. Code comments and user-facing text use direct language. Users get corrected documentation links and current workspace commands. One source generates both package READMEs, and removing the missing tox environment reference lets contributors run the repository fix command.
1 parent 77655bb commit 7c729de

137 files changed

Lines changed: 3436 additions & 4434 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
Lines changed: 15 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,46 @@
1-
name: "🐛 pyproject-fmt: Bug Report"
1+
name: "pyproject-fmt bug"
22
description: Report a bug in pyproject-fmt
33
labels: ["bug", "pyproject-fmt"]
44
body:
5-
- type: markdown
6-
attributes:
7-
value: |
8-
Thank you for taking the time to report a bug in pyproject-fmt.
9-
Please fill out the sections below to help us understand and reproduce the issue.
105
- type: textarea
116
id: description
127
attributes:
13-
label: 📝 Description
14-
description: A clear and concise description of what the bug is.
15-
placeholder: Describe the issue you encountered...
8+
label: Description
9+
description: Describe the failure and how to reproduce it.
10+
placeholder: What command did you run, and what happened?
1611
validations:
1712
required: true
1813
- type: textarea
1914
id: input
2015
attributes:
21-
label: 📄 Input pyproject.toml
22-
description: The pyproject.toml content that triggers the bug.
23-
placeholder: Paste the relevant portion of your pyproject.toml here
16+
label: Input pyproject.toml
17+
description: Include the smallest file that reproduces the failure.
18+
placeholder: Paste TOML here
2419
render: toml
2520
validations:
2621
required: true
2722
- type: textarea
2823
id: expected
2924
attributes:
30-
label: Expected output
31-
description: What you expected the formatted output to look like.
25+
label: Expected output
26+
description: Show the expected TOML.
3227
render: toml
3328
- type: textarea
3429
id: actual
3530
attributes:
36-
label: Actual output
37-
description: What actually happened (formatted output or error message).
31+
label: Actual output
32+
description: Show the resulting TOML or error.
3833
render: toml
3934
- type: input
4035
id: version
4136
attributes:
42-
label: 🏷️ Version
43-
description: Output of `pyproject-fmt --version`
37+
label: Version
38+
description: Paste the output of `pyproject-fmt --version`.
4439
placeholder: "pyproject-fmt 2.x.x"
4540
validations:
4641
required: true
4742
- type: textarea
4843
id: additional
4944
attributes:
50-
label: 📎 Additional context
51-
description: Any other relevant context (OS, Python version, configuration options used).
45+
label: Environment
46+
description: Include the operating system, Python version, and relevant formatter settings.
Lines changed: 11 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,31 @@
1-
name: "pyproject-fmt: Feature Request"
1+
name: "pyproject-fmt feature"
22
description: Suggest an enhancement for pyproject-fmt
33
labels: ["enhancement", "pyproject-fmt"]
44
body:
5-
- type: markdown
6-
attributes:
7-
value: |
8-
Thank you for suggesting an improvement to pyproject-fmt.
9-
Please describe your idea so we can understand the use case and potential implementation.
105
- type: textarea
116
id: description
127
attributes:
13-
label: 📝 Description
14-
description: A clear and concise description of the feature you'd like.
15-
placeholder: Describe the feature or improvement...
8+
label: Proposal
9+
description: Describe the requested formatter behavior.
10+
placeholder: What should pyproject-fmt do?
1611
validations:
1712
required: true
1813
- type: textarea
1914
id: use-case
2015
attributes:
21-
label: 🎯 Use case
22-
description: Explain the problem this would solve or the workflow it would improve.
23-
placeholder: This would help when...
16+
label: Use case
17+
description: Explain the current problem and who encounters it.
18+
placeholder: Include a concrete workflow or file.
2419
validations:
2520
required: true
2621
- type: textarea
2722
id: example
2823
attributes:
29-
label: 📄 Example
30-
description: If applicable, show an example of the desired input/output behavior.
24+
label: Example
25+
description: Show input and expected output when possible.
3126
render: toml
3227
- type: textarea
3328
id: alternatives
3429
attributes:
35-
label: 🔄 Alternatives considered
36-
description: Any alternative solutions or workarounds you've considered.
30+
label: Alternatives
31+
description: List current workarounds or other designs you considered.
Lines changed: 15 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,46 @@
1-
name: "🐛 tox-toml-fmt: Bug Report"
1+
name: "tox-toml-fmt bug"
22
description: Report a bug in tox-toml-fmt
33
labels: ["bug", "tox-toml-fmt"]
44
body:
5-
- type: markdown
6-
attributes:
7-
value: |
8-
Thank you for taking the time to report a bug in tox-toml-fmt.
9-
Please fill out the sections below to help us understand and reproduce the issue.
105
- type: textarea
116
id: description
127
attributes:
13-
label: 📝 Description
14-
description: A clear and concise description of what the bug is.
15-
placeholder: Describe the issue you encountered...
8+
label: Description
9+
description: Describe the failure and how to reproduce it.
10+
placeholder: What command did you run, and what happened?
1611
validations:
1712
required: true
1813
- type: textarea
1914
id: input
2015
attributes:
21-
label: 📄 Input tox.toml
22-
description: The tox.toml content that triggers the bug.
23-
placeholder: Paste the relevant portion of your tox.toml here
16+
label: Input tox.toml
17+
description: Include the smallest file that reproduces the failure.
18+
placeholder: Paste TOML here
2419
render: toml
2520
validations:
2621
required: true
2722
- type: textarea
2823
id: expected
2924
attributes:
30-
label: Expected output
31-
description: What you expected the formatted output to look like.
25+
label: Expected output
26+
description: Show the expected TOML.
3227
render: toml
3328
- type: textarea
3429
id: actual
3530
attributes:
36-
label: Actual output
37-
description: What actually happened (formatted output or error message).
31+
label: Actual output
32+
description: Show the resulting TOML or error.
3833
render: toml
3934
- type: input
4035
id: version
4136
attributes:
42-
label: 🏷️ Version
43-
description: Output of `tox-toml-fmt --version`
37+
label: Version
38+
description: Paste the output of `tox-toml-fmt --version`.
4439
placeholder: "tox-toml-fmt 1.x.x"
4540
validations:
4641
required: true
4742
- type: textarea
4843
id: additional
4944
attributes:
50-
label: 📎 Additional context
51-
description: Any other relevant context (OS, Python version, configuration options used).
45+
label: Environment
46+
description: Include the operating system, Python version, and relevant formatter settings.
Lines changed: 11 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,31 @@
1-
name: "tox-toml-fmt: Feature Request"
1+
name: "tox-toml-fmt feature"
22
description: Suggest an enhancement for tox-toml-fmt
33
labels: ["enhancement", "tox-toml-fmt"]
44
body:
5-
- type: markdown
6-
attributes:
7-
value: |
8-
Thank you for suggesting an improvement to tox-toml-fmt.
9-
Please describe your idea so we can understand the use case and potential implementation.
105
- type: textarea
116
id: description
127
attributes:
13-
label: 📝 Description
14-
description: A clear and concise description of the feature you'd like.
15-
placeholder: Describe the feature or improvement...
8+
label: Proposal
9+
description: Describe the requested formatter behavior.
10+
placeholder: What should tox-toml-fmt do?
1611
validations:
1712
required: true
1813
- type: textarea
1914
id: use-case
2015
attributes:
21-
label: 🎯 Use case
22-
description: Explain the problem this would solve or the workflow it would improve.
23-
placeholder: This would help when...
16+
label: Use case
17+
description: Explain the current problem and who encounters it.
18+
placeholder: Include a concrete workflow or file.
2419
validations:
2520
required: true
2621
- type: textarea
2722
id: example
2823
attributes:
29-
label: 📄 Example
30-
description: If applicable, show an example of the desired input/output behavior.
24+
label: Example
25+
description: Show input and expected output when possible.
3126
render: toml
3227
- type: textarea
3328
id: alternatives
3429
attributes:
35-
label: 🔄 Alternatives considered
36-
description: Any alternative solutions or workarounds you've considered.
30+
label: Alternatives
31+
description: List current workarounds or other designs you considered.

.github/SECURITY.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,9 @@
22

33
## Supported Versions
44

5-
| Version | Supported |
6-
| ------- | ------------------ |
7-
| 1.0 + | :white_check_mark: |
8-
| < 1.0 | :x: |
5+
Version 1.0 and later receives security updates. Earlier releases do not.
96

107
## Reporting a Vulnerability
118

12-
To report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security). Tidelift
13-
will coordinate the fix and disclosure.
9+
Report vulnerabilities through the [Tidelift security contact](https://tidelift.com/security). Tidelift coordinates the
10+
fix and disclosure.

CODE_OF_CONDUCT.md

Lines changed: 29 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,60 +1,50 @@
11
# Contributor Covenant Code of Conduct
22

3-
## Our Pledge
3+
## Pledge
44

5-
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making
6-
participation in our project and our community a harassment-free experience for everyone, regardless of age, body size,
7-
disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race,
8-
religion, or sexual identity and orientation.
5+
Contributors and maintainers commit to a harassment-free community without regard to age, body size, disability,
6+
ethnicity, gender identity or expression, experience, nationality, appearance, race, religion, sexual identity, or
7+
sexual orientation.
98

10-
## Our Standards
9+
## Standards
1110

12-
Examples of behavior that contributes to creating a positive environment include:
11+
Expected conduct includes:
1312

14-
- Using welcoming and inclusive language
15-
- Being respectful of differing viewpoints and experiences
16-
- Gracefully accepting constructive criticism
17-
- Focusing on what is best for the community
18-
- Showing empathy towards other community members
13+
- using inclusive language;
14+
- respecting different viewpoints and experiences;
15+
- accepting constructive criticism;
16+
- putting the community's interests first;
17+
- showing empathy toward other community members.
1918

20-
Examples of unacceptable behavior by participants include:
19+
Unacceptable conduct includes:
2120

22-
- The use of sexualized language or imagery and unwelcome sexual attention or advances
23-
- Trolling, insulting/derogatory comments, and personal or political attacks
24-
- Public or private harassment
25-
- Publishing others' private information, such as a physical or electronic address, without explicit permission
26-
- Other conduct which could reasonably be considered inappropriate in a professional setting
21+
- sexualized language, imagery, attention, or advances;
22+
- trolling, insults, derogatory comments, or personal and political attacks;
23+
- public or private harassment;
24+
- publishing another person's private information without permission;
25+
- conduct that a professional setting would reject.
2726

28-
## Our Responsibilities
27+
## Maintainer responsibilities
2928

30-
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take
31-
appropriate and fair corrective action in response to any instances of unacceptable behavior.
32-
33-
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits,
34-
issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any
35-
contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
29+
Maintainers clarify these standards and respond to violations under this code. They may remove or reject comments,
30+
commits, code, wiki edits, issues, or other contributions that violate this code. They may also ban contributors whose
31+
conduct is threatening, offensive, or harmful.
3632

3733
## Scope
3834

39-
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the
40-
project or its community. Examples of representing a project or community include using an official project e-mail
41-
address, posting via an official social media account, or acting as an appointed representative at an online or offline
42-
event. Representation of a project may be further defined and clarified by project maintainers.
35+
This code applies in project spaces and when someone represents the project in public. Representation includes using a
36+
project email address or social account and acting as an appointed representative at an event. Maintainers may define
37+
other forms of representation.
4338

4439
## Enforcement
4540

46-
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at
47-
gaborbernat@python.org. The project team will review and investigate all complaints, and will respond in a way that it
48-
deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the
49-
reporter of an incident. Further details of specific enforcement policies may be posted separately.
41+
Report abusive, harassing, or unacceptable conduct to gaborbernat@python.org. The project team will investigate and
42+
respond according to the circumstances while protecting the reporter's identity.
5043

51-
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent
52-
repercussions as determined by other members of the project's leadership.
44+
Maintainers who fail to enforce this code in good faith may face consequences set by other project leaders.
5345

5446
## Attribution
5547

56-
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at
57-
[https://www.contributor-covenant.org/version/1/4/code-of-conduct.html][version]
48+
Adapted from [Contributor Covenant 1.4][version].
5849

59-
[homepage]: https://www.contributor-covenant.org/
60-
[version]: https://www.contributor-covenant.org/version/1/4/
50+
[version]: https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

0 commit comments

Comments
 (0)