Skip to content

Commit 0f30f5b

Browse files
authored
Update README.md
1 parent 7d0e687 commit 0f30f5b

1 file changed

Lines changed: 36 additions & 0 deletions

File tree

README.md

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

0 commit comments

Comments
 (0)