Skip to content

Latest commit

 

History

History
67 lines (43 loc) · 1.78 KB

CONTRIBUTING.md

File metadata and controls

67 lines (43 loc) · 1.78 KB
Raw

Contributing to SolidSheets

Thank you for considering contributing to SolidSheets! We welcome your contributions.

Before contributing, please take a moment to review this document to ensure a smooth and efficient collaboration process.

Ways to Contribute

  • Reporting issues
  • Fixing bugs
  • Implementing new features
  • Improving documentation
  • Refactoring code
  • Providing suggestions and feedback

Getting Started

  1. Fork the repository to your GitHub account.

  2. Clone the forked repository to your local machine:

    git clone https://github.com/berkaygediz/SolidSheets.git

  3. Set up your development environment. You may need to install dependencies:

    # Install required dependencies
# Example: PySide6
pip install PySide6

  4. Make your changes and modifications.

  5. Ensure that your changes pass the existing tests (if available) and adhere to the project's coding standards.

  6. Commit your changes and push to your fork:

    git add .
git commit -m "Brief description of your changes"
git push origin main

  7. Create a pull request (PR) to the main branch of the original repository.

  8. Wait for a review and address any feedback or comments raised during the review process.

Code Guidelines

  • Follow the existing code style and conventions.
  • Write clear and informative commit messages.
  • Keep the code clean and maintainable.

Reporting Issues

If you encounter any issues or bugs, please report them by opening an issue on the repository. Include relevant information to reproduce the issue and steps to replicate it.

Development Environment

  • Python 3.x
  • PySide6

License

By contributing to SolidSheets, you agree that your contributions will be licensed under the project's LICENSE.