Skip to content

Latest commit

 

History

History
94 lines (68 loc) · 2.99 KB

CONTRIBUTING.md

File metadata and controls

94 lines (68 loc) · 2.99 KB

Contributing to Math Mania

Thank you for considering contributing to Math Mania! Your contributions are essential to help make this project better.

How to Contribute

  1. Fork the Repository

  2. Clone the Forked Repository

    • Clone the forked repository to your local machine. 
      git clone https://github.com/your-username/math-mania.git
    • Navigate to the project directory. 
      cd math-mania

  3. Create a Branch

    • Create a new branch for your feature or bug fix. 
      git checkout -b feature/AmazingFeature
    • Use a descriptive name for your branch.

  4. Make Changes

    • Make your changes to the codebase.
    • Ensure your code follows the project's coding standards.
    • Test your changes thoroughly.

  5. Commit Your Changes

    • Add the changed files. 
      git add .
    • Commit your changes with a descriptive commit message. 
      git commit -m 'Add AmazingFeature'

  6. Push to Your Fork

    • Push your changes to your forked repository. 
      git push origin feature/AmazingFeature

  7. Create a Pull Request

    • Navigate to the original repository on GitHub.
    • Click on the "Pull Requests" tab and then the "New Pull Request" button.
    • Select your fork and branch, and create the pull request.
    • Provide a detailed description of your changes.

Code Style

  • Follow the existing code style and conventions.
  • Write clear, concise, and descriptive commit messages.
  • Ensure your code is well-documented and easy to understand.

Reporting Bugs

If you find a bug, please create an issue on the issue tracker with the following information:

  • A clear and descriptive title.
  • A detailed description of the problem.
  • Steps to reproduce the issue.
  • Any relevant screenshots or code snippets.

Feature Requests

If you have an idea for a new feature, please create an issue on the issue tracker with the following information:

  • A clear and descriptive title.
  • A detailed description of the proposed feature.
  • Any relevant mockups or examples.

Getting Help

If you need help with the project, please open an issue on the issue tracker and provide a detailed description of the problem.

Code of Conduct

By participating in this project, you agree to abide by the Code of Conduct. Please read it to understand the expected behavior.

Acknowledgements

Thank you to all the contributors who have helped make this project better. Your contributions are greatly appreciated!

Contact

If you have any questions or need further assistance, feel free to contact Pabitra Banerjee at [email protected].

Happy coding!