Skip to content
This repository was archived by the owner on Mar 30, 2025. It is now read-only.

Commit 3dfb42d

Browse files
staticdevstaticdev
authored
Merge pull request #74 from staticdev/feature/improved-usage-documentation
Improved usage documentation
2 parents b0fc785 + 15ac840 commit 3dfb42d

File tree

3 files changed

+194
-5
lines changed

3 files changed

+194
-5
lines changed

‎CODE_OF_CONDUCT.rst‎

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
Contributor Covenant Code of Conduct
2+
====================================
3+
4+
Our Pledge
5+
----------
6+
7+
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
8+
9+
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
10+
11+
12+
Our Standards
13+
-------------
14+
15+
Examples of behavior that contributes to a positive environment for our community include:
16+
17+
- Demonstrating empathy and kindness toward other people
18+
- Being respectful of differing opinions, viewpoints, and experiences
19+
- Giving and gracefully accepting constructive feedback
20+
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
21+
- Focusing on what is best not just for us as individuals, but for the overall community
22+
23+
Examples of unacceptable behavior include:
24+
25+
- The use of sexualized language or imagery, and sexual attention or
26+
advances of any kind
27+
- Trolling, insulting or derogatory comments, and personal or political attacks
28+
- Public or private harassment
29+
- Publishing others' private information, such as a physical or email
30+
address, without their explicit permission
31+
- Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
Enforcement Responsibilities
35+
----------------------------
36+
37+
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
38+
39+
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
40+
41+
42+
Scope
43+
-----
44+
45+
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
46+
47+
48+
Enforcement
49+
-----------
50+
51+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at staticdev-support@protonmail.com. All complaints will be reviewed and investigated promptly and fairly.
52+
53+
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
54+
55+
56+
Enforcement Guidelines
57+
----------------------
58+
59+
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
60+
61+
62+
1. Correction
63+
~~~~~~~~~~~~~
64+
65+
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
66+
67+
**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
68+
69+
70+
2. Warning
71+
~~~~~~~~~~
72+
73+
**Community Impact**: A violation through a single incident or series of actions.
74+
75+
**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
76+
77+
78+
3. Temporary Ban
79+
~~~~~~~~~~~~~~~~
80+
81+
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
82+
83+
**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
84+
85+
86+
4. Permanent Ban
87+
~~~~~~~~~~~~~~~~
88+
89+
**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
90+
91+
**Consequence**: A permanent ban from any sort of public interaction within the community.
92+
93+
94+
Attribution
95+
-----------
96+
97+
This Code of Conduct is adapted from the `Contributor Covenant <homepage_>`__, version 2.0,
98+
available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
99+
100+
Community Impact Guidelines were inspired by `Mozilla’s code of conduct enforcement ladder <https://github.com/mozilla/diversity>`__.
101+
102+
.. _homepage: https://www.contributor-covenant.org
103+
104+
For answers to common questions about this code of conduct, see the FAQ at
105+
https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

‎CONTRIBUTING.rst‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
Contributor Guide
2+
=================
3+
4+
Thank you for your interest in improving this project.
5+
This project is open-source under the `MIT license`_ and
6+
welcomes contributions in the form of bug reports, feature requests, and pull requests.
7+
8+
Here is a list of important resources for contributors:
9+
10+
- `Source Code`_
11+
- `Issue Tracker`_
12+
- `Code of Conduct`_
13+
14+
.. _MIT license: https://opensource.org/licenses/MIT
15+
.. _Source Code: https://github.com/staticdev/ansible-role-pyenv
16+
.. _Issue Tracker: https://github.com/staticdev/ansible-role-pyenv/issues
17+
18+
How to report a bug
19+
-------------------
20+
21+
Report bugs on the `Issue Tracker`_.
22+
23+
When filing an issue, make sure to answer these questions:
24+
25+
- Which operating system and Ansible version are you using?
26+
- Which version of this project are you using?
27+
- What did you do?
28+
- What did you expect to see?
29+
- What did you see instead?
30+
31+
The best way to get your bug fixed is to provide a test case,
32+
and/or steps to reproduce the issue.
33+
34+
35+
How to request a feature
36+
------------------------
37+
38+
Request features on the `Issue Tracker`_.
39+
40+
How to submit changes
41+
---------------------
42+
43+
Open a `pull request`_ to submit changes to this project.
44+
45+
Your pull request needs to meet the following guidelines for acceptance:
46+
47+
- The Nox test suite must pass without errors and warnings.
48+
- Include unit tests. This project maintains 100% code coverage.
49+
- If your changes add functionality, update the documentation accordingly.
50+
51+
Feel free to submit early, though—we can always iterate on this.
52+
53+
To run linting and code formatting checks before commiting your change, you can install pre-commit as a Git hook by running the following command:
54+
55+
.. code:: console
56+
57+
$ nox --session=pre-commit -- install
58+
59+
It is recommended to open an issue before starting work on anything.
60+
This will allow a chance to talk it over with the owners and validate your approach.
61+
62+
.. _pull request: https://github.com/staticdev/ansible-role-pyenv/pulls
63+
.. github-only
64+
.. _Code of Conduct: CODE_OF_CONDUCT.rst

‎README.rst‎

Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -58,14 +58,20 @@ Dependencies
5858
Example Playbook
5959
----------------
6060

61+
Here are some common usages of this role.
62+
63+
1. Role without IDE:
64+
6165
.. code:: yaml
6266
63-
# role without IDE
6467
- hosts: all
6568
roles:
6669
- role: staticdev.python-developer
6770
68-
# role with pyenv attributes
71+
2. Role defining Python versions:
72+
73+
.. code:: yaml
74+
6975
- hosts: all
7076
roles:
7177
- role: staticdev.python-developer
@@ -76,15 +82,21 @@ Example Playbook
7682
- "3.9.6"
7783
- "3.8.11"
7884
79-
# role with pycharm
85+
3. Role with Pycharm
86+
87+
.. code:: yaml
88+
8089
- hosts: all
8190
roles:
8291
- role: staticdev.python-developer
8392
vars:
8493
install_pycharm: true
8594
pycharm_flavor: edu
8695
87-
# role with vscode and extensions
96+
4. Role with vscode and extensions
97+
98+
.. code:: yaml
99+
88100
- hosts: all
89101
roles:
90102
- role: staticdev.python-developer
@@ -96,10 +108,18 @@ Example Playbook
96108
- shan.code-settings-sync
97109
98110
111+
Contributing
112+
------------
113+
114+
Contributions are very welcome.
115+
To learn more, see the `Contributor Guide`_.
116+
117+
99118
License
100119
-------
101120

102-
MIT
121+
Distributed under the terms of the MIT_ license,
122+
*Ansible role Python developer* is free and open source software.
103123

104124

105125
Author Information

0 commit comments

Comments
 (0)