Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
75 lines (48 loc) · 1.74 KB

CONTRIBUTING.md

File metadata and controls

75 lines (48 loc) · 1.74 KB

Contributing Guidelines

Thank you for your interest in contributing to this repository!

This project will appreciate any type of contribution whether it is bug fixes or improving efficiency. Every contribution big or small is appreciated!

Please read the guidelines below to ensure smooth and meaningful contributions.

How to Contribute

  1. Fork the repository

  2. Create a new branch

git checkout -b <feature-name>

  1. Make your changes

  2. Stage your changes

git add <your-changes>
  1. Commit your changes
git commit -m "Describe your changes here"
  1. Push the changes to your fork
git push origin <branch-name>
  1. Open a Pull Request

A good PR consists of:

  • A short, clear title
  • Explanation of what changed and why
  • Screenshots or logs (if your change affects output/visuals)

Pull Request Rules

To maintain quality and consistency across GameOfAlgo:

  • Create an Issue first, and link it to your PR
  • Code must run without errors
  • Keep Jupyter Notebooks clean
  • Remove unnecessary prints/output
  • Keep cells organized
  • Document any new feature or modification
  • Use good naming conventions and folder structure
  • Add comments wherever your logic might be unclear

Issue Guidelines

Before creating a new issue:

  • Check if an issue already exists
  • Provide a detailed description of the bug, idea, or enhancement
  • Include screenshots or error messages when possible
  • Suggest a possible fix (optional but helpful)

Testing Your Changes

Before submitting a pull request, double-check for finding any error.

Code of Conduct

Thank You! Your effort helps improve this project and supports the open-source community. Feel free to reach out by opening an issue if you have any questions!