|
1 | | -# Contributor Covenant Code of Conduct |
| 1 | +# Contributing to the `python-ms` project |
2 | 2 |
|
3 | | -## Our Pledge |
| 3 | +## Filing a bug report |
4 | 4 |
|
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, religion, or sexual identity |
10 | | -and orientation. |
| 5 | +To file a bug report, [open the Issues tab][Issues] and add a new issue, |
| 6 | +labeling it as a bug report. If you wish to try and fix it yourself, add |
| 7 | +yourself as a contributor to that issue. You are allowed to group similar |
| 8 | +bugs into one issue report, as long as you don't exceed the limit of three |
| 9 | +different bugs. Otherwise, make another issue. |
11 | 10 |
|
12 | | -We pledge to act and interact in ways that contribute to an open, welcoming, |
13 | | -diverse, inclusive, and healthy community. |
| 11 | +## Suggesting a new feature |
14 | 12 |
|
15 | | -## Our Standards |
| 13 | +To suggest a new feature: |
16 | 14 |
|
17 | | -Examples of behavior that contributes to a positive environment for our |
18 | | -community include: |
| 15 | +* For small suggestions, [you can go directly to the Projects tab][Projects] |
| 16 | + and write a suggestion to the Suggestions/Ideas column |
| 17 | +* For medium-to-large suggestions, write an issue, mark it as part of the |
| 18 | + current project and label it as a suggestion |
19 | 19 |
|
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 |
26 | | - overall community |
| 20 | +You may NOT suggest features through email to the core developers. |
27 | 21 |
|
28 | | -Examples of unacceptable behavior include: |
| 22 | +## Setting up your development environment |
29 | 23 |
|
30 | | -- The use of sexualized language or imagery, and sexual attention or |
31 | | - advances of any kind |
32 | | -- Trolling, insulting or derogatory comments, and personal or political attacks |
33 | | -- Public or private harassment |
34 | | -- Publishing others' private information, such as a physical or email |
35 | | - address, without their explicit permission |
36 | | -- Other conduct which could reasonably be considered inappropriate in a |
37 | | - professional setting |
| 24 | +Since `python-ms` has very little to do beyond programming and testing, the following should be enough for 95% of all contributors: |
38 | 25 |
|
39 | | -## Enforcement Responsibilities |
| 26 | +1. A working Git or GitHub Desktop installation |
| 27 | +2. A text editor / Python IDE |
| 28 | +3. An installation of Python that supports Python version 3.10 or higher |
| 29 | +4. The following, non-standard PyPI modules (available through pip): |
| 30 | + * `poetry` |
40 | 31 |
|
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. |
45 | | - |
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. |
50 | | - |
51 | | -## Scope |
52 | | - |
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. |
58 | | - |
59 | | -## Enforcement |
60 | | - |
61 | | -Instances of abusive, harassing, or otherwise unacceptable behavior may be |
62 | | -reported to the community leaders responsible for enforcement at |
63 | | -lari.liuhamo+github@gmail.com. |
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 |
86 | | -of actions. |
87 | | - |
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 |
93 | | -permanent 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 |
113 | | -the community. |
114 | | - |
115 | | -## Attribution |
116 | | - |
117 | | -This Code of Conduct is adapted from the [Contributor Covenant][homepage], |
118 | | -version 2.0, available [here][Covenant]. |
119 | | - |
120 | | -Community Impact Guidelines were inspired by [Mozilla's code of conduct |
121 | | -enforcement ladder](https://github.com/mozilla/diversity). |
122 | | - |
123 | | -For answers to common questions about this code of conduct, see the FAQ [here][FAQ]. Translations are available [here][Translations]. |
124 | | - |
125 | | -[homepage]: https://www.contributor-covenant.org |
126 | | -[Covenant]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html |
127 | | -[FAQ]: https://www.contributor-covenant.org/faq |
128 | | -[Translations]: https://www.contributor-covenant.org/translations |
| 32 | +[Issues]: https://github.com/Diapolo10/python-ms/issues |
| 33 | +[Projects]: https://github.com/Diapolo10/python-ms/projects |
0 commit comments