Skip to content

Commit a9fb392

Browse files
takos22takos22
committed
docs: Add CONTRIBUTING.md and CODE_OF_CONDUCT.md
1 parent 48656b1 commit a9fb392

File tree

2 files changed

+276
-0
lines changed

2 files changed

+276
-0
lines changed

‎CODE_OF_CONDUCT.md

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
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, 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.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
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 overall
26+
community
27+
28+
Examples of unacceptable behavior include:
29+
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
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email address,
35+
without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
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 email 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+
[takos2210@gmail.com](mailto:takos2210@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 of
86+
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 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.
114+
115+
## Attribution
116+
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

‎CONTRIBUTING.md

Lines changed: 144 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,144 @@
1+
# Contributing to the `codingame` module
2+
3+
Thank you for your interest in contributing to this codingame API wrapper! We welcome contributions from the community to improve and expand this project. Please follow these guidelines to make the process smooth for everyone.
4+
5+
---
6+
7+
## 🚀 How to Contribute
8+
9+
1. **Fork the repository** on GitHub.
10+
2. **Clone your fork** to your local machine:
11+
12+
```sh
13+
git clone https://github.com/your-username/codingame.git
14+
```
15+
16+
3. **Create a new branch** for your feature or bugfix:
17+
18+
```sh
19+
git checkout -b feature-branch
20+
```
21+
22+
4. **Make your changes** and commit:
23+
24+
```sh
25+
git commit -m "feat: add new feature description"
26+
```
27+
28+
5. **Push your changes** to your fork:
29+
30+
```sh
31+
git push origin feature-branch
32+
```
33+
34+
6. **Create a Pull Request (PR)** from your fork to the main repository.
35+
36+
---
37+
38+
## 🛠 Setting Up the Development Environment
39+
40+
1. Install dependencies:
41+
42+
```sh
43+
pip install -r requirements.txt
44+
pip install -r async-requirements.txt
45+
pip install -r dev-requirements.txt
46+
```
47+
48+
2. (Optional) Create a virtual environment:
49+
50+
```sh
51+
python -m venv venv
52+
source venv/bin/activate # On Windows: venv\Scripts\activate
53+
```
54+
55+
---
56+
57+
## 📜 Coding Guidelines
58+
59+
- Follow **[PEP 8](https://peps.python.org/pep-0008/)** for code style.
60+
- Format code using the **formatting script**:
61+
62+
```sh
63+
./scripts/format.sh
64+
```
65+
66+
- Use **type hints** where applicable:
67+
68+
```python
69+
def add_numbers(a: int, b: int) -> int:
70+
return a + b
71+
```
72+
73+
- Write **clear docstrings** using [PEP 257](https://peps.python.org/pep-0257/).
74+
- Update docs if you can.
75+
76+
---
77+
78+
## ✅ Testing
79+
80+
- Ensure that tests pass before submitting a PR.
81+
- Setup a **`.env` file** with the necessary variables:
82+
83+
```env
84+
TEST_LOGIN_REMEMBER_ME_COOKIE=... # your remember me cookie (see docs)
85+
TEST_LOGIN_REMEMBER_ME_COOKIE_312=... # a 2nd remember me cookie (not necessary, some clash of code tests will fail though)
86+
87+
TEST_CODINGAMER_ID=... # a codingamer id (see docs)
88+
TEST_CODINGAMER_PSEUDO=... # a codingamer pseudo (see docs)
89+
TEST_CODINGAMER_PUBLIC_HANDLE=... # a codingamer public handle (see docs)
90+
91+
TEST_CLASHOFCODE_PUBLIC_HANDLE=... # a clash of code public handle (see docs)
92+
```
93+
94+
- Run tests with the **testing script**:
95+
96+
```sh
97+
./scripts/test.sh --full
98+
```
99+
100+
- If adding new functionality, include appropriate unit tests in the `tests/` directory.
101+
102+
---
103+
104+
## 📌 Commit Message Format
105+
106+
Follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/):
107+
108+
- `feat: Add a new feature`
109+
- `fix: Fix a bug`
110+
- `docs: Update documentation`
111+
- `refactor: Code refactoring without feature changes`
112+
- `test: Add or update tests`
113+
114+
Example:
115+
116+
```sh
117+
git commit -m "feat: add support for clash of codes"
118+
```
119+
120+
---
121+
122+
## 🔍 Reporting Issues
123+
124+
If you find a bug or have a feature request:
125+
126+
- Check [open issues](https://github.com/takos22/codingame/issues) to see if it's already reported.
127+
- Create a [new issue](https://github.com/takos22/codingame/issues/new) with:
128+
- A clear title and description.
129+
- Steps to reproduce (if a bug).
130+
- Expected vs. actual behavior.
131+
132+
---
133+
134+
## 🤝 Code of Conduct
135+
136+
By contributing, you agree to follow our [Code of Conduct](CODE_OF_CONDUCT.md).
137+
138+
---
139+
140+
## 💡 Need Help?
141+
142+
If you have any questions, feel free to open an issue or contact the maintainers.
143+
144+
Happy coding! 🚀

0 commit comments

Comments
 (0)