Skip to content

Commit 80480b0

Browse files
pawamoypawamoy
committed
chore: Template upgrade
1 parent 277bad0 commit 80480b0

18 files changed

+459
-511
lines changed

‎.copier-answers.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Changes here will be overwritten by Copier
2-
_commit: 0.10.6
2+
_commit: 0.11.2
33
_src_path: gh:pawamoy/copier-pdm
44
author_email: pawamoy@pm.me
55
author_fullname: Timothée Mazzucotelli

‎.github/workflows/ci.yml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ jobs:
3131
python-version: "3.8"
3232

3333
- name: Resolving dependencies
34-
run: pdm lock
34+
run: pdm lock -v
3535

3636
- name: Install dependencies
3737
run: pdm install -G duty -G docs -G quality -G typing -G security
@@ -74,6 +74,9 @@ jobs:
7474
with:
7575
python-version: ${{ matrix.python-version }}
7676

77+
- name: Resolving dependencies
78+
run: pdm lock -v
79+
7780
- name: Install dependencies
7881
run: pdm install --no-editable -G duty -G tests -G docs
7982

‎CODE_OF_CONDUCT.md

Lines changed: 105 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -2,73 +2,132 @@
22

33
## Our Pledge
44

5-
In the interest of fostering an open and welcoming environment, we as
6-
contributors and maintainers pledge to make participation in our project and
7-
our community a harassment-free experience for everyone, regardless of age, body
8-
size, disability, ethnicity, gender identity and expression, level of experience,
9-
nationality, personal appearance, race, religion, or sexual identity and
10-
orientation.
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, caste, color, religion, or sexual
10+
identity and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
1114

1215
## Our Standards
1316

14-
Examples of behavior that contributes to creating a positive environment
15-
include:
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
1619

17-
* Using welcoming and inclusive language
18-
* Being respectful of differing viewpoints and experiences
19-
* Gracefully accepting constructive criticism
20-
* Focusing on what is best for the community
21-
* Showing empathy towards other community members
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the overall
26+
community
2227

23-
Examples of unacceptable behavior by participants include:
28+
Examples of unacceptable behavior include:
2429

25-
* The use of sexualized language or imagery and unwelcome sexual attention or
26-
advances
27-
* Trolling, insulting/derogatory comments, and personal or political attacks
30+
* The use of sexualized language or imagery, and sexual attention or advances of
31+
any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
2833
* Public or private harassment
29-
* Publishing others' private information, such as a physical or electronic
30-
address, without explicit permission
34+
* Publishing others' private information, such as a physical or email address,
35+
without their explicit permission
3136
* Other conduct which could reasonably be considered inappropriate in a
3237
professional setting
3338

34-
## Our Responsibilities
39+
## Enforcement Responsibilities
3540

36-
Project maintainers are responsible for clarifying the standards of acceptable
37-
behavior and are expected to take appropriate and fair corrective action in
38-
response to any instances of unacceptable behavior.
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
3945

40-
Project maintainers have the right and responsibility to remove, edit, or
41-
reject comments, commits, code, wiki edits, issues, and other contributions
42-
that are not aligned with this Code of Conduct, or to ban temporarily or
43-
permanently any contributor for other behaviors that they deem inappropriate,
44-
threatening, offensive, or harmful.
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
4550

4651
## Scope
4752

48-
This Code of Conduct applies both within project spaces and in public spaces
49-
when an individual is representing the project or its community. Examples of
50-
representing a project or community include using an official project e-mail
51-
address, posting via an official social media account, or acting as an appointed
52-
representative at an online or offline event. Representation of a project may be
53-
further defined and clarified by project maintainers.
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
5458

5559
## Enforcement
5660

5761
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58-
reported by contacting the project team at pawamoy@pm.me. All
59-
complaints will be reviewed and investigated and will result in a response that
60-
is deemed necessary and appropriate to the circumstances. The project team is
61-
obligated to maintain confidentiality concerning the reporter of an incident.
62-
Further details of specific enforcement policies may be posted separately.
62+
reported to the community leaders responsible for enforcement at
63+
pawamoy@pm.me.
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series of
86+
actions.
6387

64-
Project maintainers who do not follow or enforce the Code of Conduct in good
65-
faith may face temporary or permanent repercussions as determined by other
66-
members of the project's leadership.
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or permanent
93+
ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within the
113+
community.
67114

68115
## Attribution
69116

70-
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71-
available at [http://contributor-covenant.org/version/1/4][version]
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.1, available at
119+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
120+
121+
Community Impact Guidelines were inspired by
122+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
123+
124+
For answers to common questions about this code of conduct, see the FAQ at
125+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
126+
[https://www.contributor-covenant.org/translations][translations].
127+
128+
[homepage]: https://www.contributor-covenant.org
129+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
130+
[Mozilla CoC]: https://github.com/mozilla/diversity
131+
[FAQ]: https://www.contributor-covenant.org/faq
132+
[translations]: https://www.contributor-covenant.org/translations
72133

73-
[homepage]: http://contributor-covenant.org
74-
[version]: http://contributor-covenant.org/version/1/4/

‎CONTRIBUTING.md

Lines changed: 28 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,14 @@ make setup
1919
> you'll need to install
2020
> [PDM](https://github.com/pdm-project/pdm)
2121
> manually.
22-
>
22+
>
2323
> You can install it with:
24-
>
24+
>
2525
> ```bash
2626
> python3 -m pip install --user pipx
2727
> pipx install pdm
2828
> ```
29-
>
29+
>
3030
> Now you can try running `make setup` again,
3131
> or simply `pdm install`.
3232
@@ -75,20 +75,27 @@ Don't bother updating the changelog, we will take care of this.
7575
7676
## Commit message convention
7777
78-
Commits messages must follow the
79-
[Angular style](https://gist.github.com/stephenparish/9941e89d80e2bc58a153#format-of-the-commit-message):
78+
Commit messages must follow our convention based on the
79+
[Angular style](https://gist.github.com/stephenparish/9941e89d80e2bc58a153#format-of-the-commit-message)
80+
or the [Karma convention](https://karma-runner.github.io/4.0/dev/git-commit-msg.html):
8081
8182
```
8283
<type>[(scope)]: Subject
8384
8485
[Body]
8586
```
8687
88+
**Subject and body must be valid Markdown.**
89+
Subject must have proper casing (uppercase for first letter
90+
if it makes sense), but no dot at the end, and no punctuation
91+
in general.
92+
8793
Scope and body are optional. Type can be:
8894

8995
- `build`: About packaging, building wheels, etc.
9096
- `chore`: About packaging or repo/files management.
9197
- `ci`: About Continuous Integration.
98+
- `deps`: Dependencies update.
9299
- `docs`: About documentation.
93100
- `feat`: New feature.
94101
- `fix`: Bug fix.
@@ -97,16 +104,28 @@ Scope and body are optional. Type can be:
97104
- `style`: A change in code style/format.
98105
- `tests`: About tests.
99106

100-
**Subject (and body) must be valid Markdown.**
101-
If you write a body, please add issues references at the end:
107+
If you write a body, please add trailers at the end
108+
(for example issues and PR references, or co-authors),
109+
without relying on GitHub's flavored Markdown:
102110

103111
```
104112
Body.
105113
106-
References: #10, #11.
107-
Fixes #15.
114+
Issue #10: https://github.com/namespace/project/issues/10
115+
Related to PR namespace/other-project#15: https://github.com/namespace/other-project/pull/15
108116
```
109117

118+
These "trailers" must appear at the end of the body,
119+
without any blank lines between them. The trailer title
120+
can contain any character except colons `:`.
121+
We expect a full URI for each trailer, not just GitHub autolinks
122+
(for example, full GitHub URLs for commits and issues,
123+
not the hash or the #issue-number).
124+
125+
We do not enforce a line length on commit messages summary and body,
126+
but please avoid very long summaries, and very long lines in the body,
127+
unless they are part of code blocks that must not be wrapped.
128+
110129
## Pull requests guidelines
111130

112131
Link to any related issue in the Pull Request message.

‎Makefile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ setup:
4141

4242
.PHONY: check
4343
check:
44-
@bash scripts/multirun.sh duty check-quality check-types check-docs
44+
@pdm multirun duty check-quality check-types check-docs
4545
@$(DUTY) check-dependencies
4646

4747
.PHONY: $(BASIC_DUTIES)
@@ -50,4 +50,4 @@ $(BASIC_DUTIES):
5050

5151
.PHONY: $(QUALITY_DUTIES)
5252
$(QUALITY_DUTIES):
53-
@bash scripts/multirun.sh duty $@ $(call args,$@)
53+
@pdm multirun duty $@ $(call args,$@)

‎config/black.toml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[tool.black]
2+
line-length = 120
3+
exclude = "tests/fixtures"

‎config/coverage.ini

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,9 @@ omit =
1717
src/*/__init__.py
1818
src/*/__main__.py
1919
tests/__init__.py
20+
exclude_lines =
21+
pragma: no cover
22+
if TYPE_CHECKING
2023

2124
[coverage:json]
2225
output = htmlcov/coverage.json

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy