Skip to content

Latest commit

 

History

History
46 lines (29 loc) · 1.49 KB

CONTRIBUTING.md

File metadata and controls

46 lines (29 loc) · 1.49 KB

Contributing

We welcome contributions of all kinds to improve this project! Here's how you can get involved:

  1. Fork the Repository: Start by forking the repository to your GitHub account.

  2. Clone Your Fork: Clone the forked repository to your local machine:

    git clone <repo_url>
cd repo_dir

  3. Create a Branch: Create a new branch for your feature or bug fix:

    git checkout -b feature-name

  4. Make Changes: Make your changes to the codebase. Be sure to follow existing code style and conventions.

  5. Commit Changes: Commit your changes with a clear and descriptive message:

    git commit -m "Add detailed description of the changes"

  6. Push Changes: Push your changes to your fork:

    git push origin feature-name

  7. Submit a Pull Request: Open a pull request from your branch to the main repository's branch. Include a detailed description of your changes and the problem they solve.

  8. Review and Feedback: Participate in the review process. Make any requested changes, and your contribution will be merged!

Guidelines

  • Ensure your code follows the existing style and conventions.
  • Include tests for any new functionality or bug fixes.
  • Write clear, concise commit messages and pull request descriptions.

Issues

Feel free to report bugs or suggest enhancements by creating an issue. Be sure to include detailed information about the problem and, if possible, steps to reproduce it.