Skip to content

Latest commit

 

History

History
43 lines (42 loc) · 2.15 KB

CONTRIBUTING.md

File metadata and controls

43 lines (42 loc) · 2.15 KB

Contributing Guide

Thank you for considering contributing to our project! We value your input and appreciate any help you can provide. Here’s a step-by-step guide to help you get started with contributing:

How to Contribute

  1. Fork the Repository
    • Click the "Fork" button at the top right of the repository page on GitHub to create a copy of the repository under your own GitHub account.
  2. Clone Your Fork
    • Clone the forked repository to your local machine: 
      git clone https://github.com/mi7773/maze_project.git
cd maze_project
  3. Create a New Branch
    • Create a new branch for your changes: 
      git checkout -b feature/YourFeature
    • Replace YourFeature with a descriptive name for your branch.
  4. Make Your Changes
    • Make the necessary changes or additions to the code.
  5. Commit Your Changes
    • Commit your changes with a meaningful message: 
      git commit -m "Add detailed description of your changes"
  6. Push Your Changes
    • Push your branch to your forked repository: 
      git push origin feature/YourFeature
  7. Create a Pull Request
    • Go to the main repository on GitHub and click the "New Pull Request" button.
    • Select your branch and provide a description of your changes.
    • Submit the Pull Request for review.

Guidelines

  • Code Style: Follow the coding style used in the project to maintain consistency.
  • Documentation: Update the documentation if your changes affect the way the project is used or built.
  • Testing: Ensure that your changes do not break any existing functionality and that they are thoroughly tested.

Reporting Issues

If you find a bug or have a suggestion, please open an issue on GitHub. Provide as much detail as possible to help us understand and address the issue.

Contact

For any questions or if you need help, feel free to reach out to us on GitHub Discussions or via email.

Thank you for contributing to our project!