Skip to content

Commit 2f732ca

Browse files
committed
Minimal community requirements
* maintainers in __init__ and setup * pull request template * code of conduct (standard template)
1 parent fe74ec3 commit 2f732ca

File tree

4 files changed

+101
-0
lines changed

4 files changed

+101
-0
lines changed

.github/pull_request_template.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
<!-- Thank you for your contribution! -->
2+
3+
## What do these changes do?
4+
5+
<!-- Please give a short brief about these changes. -->
6+
7+
## Are there changes in behavior for the user?
8+
9+
<!-- Outline any notable behaviour for the end users. -->
10+
11+
## Related issue number
12+
13+
<!-- Are there any issues opened that will be resolved by merging this change? -->
14+
15+
## Checklist
16+
17+
- [ ] I think the code is well written
18+
- [ ] Unit tests for the changes exist
19+
- [ ] Documentation reflects the changes

CODE_OF_CONDUCT.md

+73
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making 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+
education, socio-economic status, nationality, personal appearance, race,
10+
religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
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
22+
23+
Examples of unacceptable behavior by participants include:
24+
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
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
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.
39+
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 to 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.
45+
46+
## Scope
47+
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.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project maintainers. 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 with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
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.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72+
73+
[homepage]: https://www.contributor-covenant.org

exec_helpers/__init__.py

+5
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,11 @@
4848
__version__ = '1.1.1'
4949
__author__ = "Alexey Stepanov"
5050
__author_email__ = '[email protected]'
51+
__maintainers__ = {
52+
'Alexey Stepanov': '[email protected]',
53+
'Antonio Esposito': '[email protected]',
54+
'Dennis Dmitriev': '[email protected]',
55+
}
5156
__url__ = 'https://github.com/python-useful-helpers/exec-helpers'
5257
__description__ = (
5358
"Execution helpers for simplified usage of subprocess and ssh."

setup.py

+4
Original file line numberDiff line numberDiff line change
@@ -244,6 +244,10 @@ def get_simple_vars_from_src(src):
244244
name='exec-helpers',
245245
author=variables['__author__'],
246246
author_email=variables['__author_email__'],
247+
maintainer=', '.join(
248+
'{name} <email>'.format(name=name, email=email)
249+
for name, email in variables['__maintainers__'].values()
250+
),
247251
url=variables['__url__'],
248252
version=variables['__version__'],
249253
license=variables['__license__'],

0 commit comments

Comments
 (0)