Skip to content

Commit 84863ba

Browse files
authored
Update README.md
1 parent a71618f commit 84863ba

1 file changed

Lines changed: 37 additions & 0 deletions

File tree

README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,3 +50,40 @@ We are on [Discord](https://the-algorithms.com/discord) and [Gitter](https://git
5050
## 📜 List of Algorithms
5151

5252
See our [directory](DIRECTORY.md) for easier navigation and a better overview of the project.
53+
54+
## 🤝 Contributing
55+
56+
We welcome contributions from the community!
57+
Whether you’re fixing a typo, improving documentation, or adding new algorithms, every contribution is valuable.
58+
59+
Before contributing, please make sure to:
60+
61+
1. Read our full [Contributing Guidelines](./CONTRIBUTING.md).
62+
2. Ensure your code follows our style guide:
63+
- Python 3.13+ compatible
64+
- Uses descriptive variable and function names
65+
- Includes type hints and docstrings with doctests
66+
3. Run the following tools locally before submitting a pull request:
67+
```bash
68+
# Format your code
69+
black .
70+
71+
# Lint and style checks
72+
ruff check
73+
74+
# Run doctests
75+
python3 -m doctest -v your_file.py
76+
77+
# Run mypy type checking
78+
mypy --ignore-missing-imports .
79+
```
80+
4. Make sure your pull request is original and not a duplicate implementation.
81+
82+
If you want to fix an existing issue, just open a PR. there’s no need to ask for assignment.
83+
For new algorithms, please go straight to submitting a pull request rather than opening an issue.
84+
85+
For more details, check the full [Contributing Guide](./CONTRIBUTING.md).
86+
87+
## 🧾 License
88+
89+
This project is licensed under the [MIT License](./LICENSE).

0 commit comments

Comments
 (0)