Skip to content

Commit 242528d

Browse files
authored
Merge pull request #6 from sany2k8/stage
Stage
2 parents aca6e93 + cb600db commit 242528d

File tree

1 file changed

+54
-0
lines changed

1 file changed

+54
-0
lines changed

CONTRIBUTING.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# Contributing to Dictory
2+
3+
Thank you for your interest in contributing to **Dictory**! Your help is appreciated.
4+
5+
## How to Contribute
6+
7+
### 1. Fork the Repository
8+
9+
Click the "Fork" button at the top right of the [repository page](https://github.com/your-username/dictory) to create your own copy.
10+
11+
### 2. Clone Your Fork
12+
13+
```bash
14+
git clone https://github.com/your-username/dictory.git
15+
cd dictory
16+
```
17+
18+
### 3. Set Up the Development Environment
19+
20+
Install dependencies:
21+
22+
```bash
23+
uv sync --extra dev
24+
```
25+
26+
### 4. Make Your Changes
27+
28+
- Follow [PEP8](https://www.python.org/dev/peps/pep-0008/) style guidelines.
29+
- Write clear, concise commit messages.
30+
- Add or update tests for your changes.
31+
32+
### 5. Run Tests
33+
34+
Before submitting, ensure all tests pass:
35+
36+
```bash
37+
uv run pytest
38+
```
39+
40+
### 6. Submit a Pull Request
41+
42+
- Push your changes to your fork.
43+
- Open a pull request against the `main` branch of the original repository.
44+
- Describe your changes and reference any related issues.
45+
46+
## Code of Conduct
47+
48+
Be respectful and considerate. See [Contributor Covenant](https://www.contributor-covenant.org/) for guidelines.
49+
50+
## Need Help?
51+
52+
Open an issue or ask in the discussions section.
53+
54+
Thank you for contributing!

0 commit comments

Comments
 (0)