🧩 Add CONTRIBUTING Guidelines & Code Style Guide #159
Description
Description
Improve the contributor onboarding experience by adding clear guidelines and standards. This will help maintain consistency, make it easier for newcomers to contribute, and reduce friction.
Tasks
- Create a
CONTRIBUTING.mdfile that includes:- How to clone the repo, install any dependencies, environment setup (if needed)
- How to run/view the “problems” (e.g. in notebooks, Python scripts)
- How to submit solutions (preferred file structure, naming conventions)
- Code style guidelines (PEP8, formatting, linting, docstrings)
- How to submit pull requests (branch name conventions, commit messages, review expectations)
- Update README to include a "Contributing" section linking to CONTRIBUTING.md
- Optionally, add issue/pr templates to guide contributors in reporting issues or submitting solutions
Why?
The repository already has many solved problems, and is widely used. Better guidelines will make it easier for others to add new problems, improve existing ones, or correct issues without confusion.