Skip to content

Latest commit

 

History

History
35 lines (22 loc) · 1.45 KB

CONTRIBUTING.md

File metadata and controls

35 lines (22 loc) · 1.45 KB
Raw

Contributing to Compressy

We welcome and appreciate contributions from the community. Please take a moment to review this document to understand how you can contribute to the Compressy project.

Getting Started

  1. Fork the repository to your GitHub account.
  2. Clone the forked repository to your local machine.
  3. Create a new branch for your changes: git checkout -b feature/YourFeature
  4. Make your modifications and ensure to test them thoroughly.
  5. Commit your changes: git commit -m 'Descriptive commit message'
  6. Push to the branch: git push origin feature/YourFeature
  7. Open a Pull Request (PR) against the main repository's main branch.

Guidelines

  • Code Style: Adhere to the coding style used in the project. Follow consistent formatting.
  • Testing: Ensure your changes are tested thoroughly and provide any necessary test cases.
  • Documentation: Update the README or other documentation if your changes impact user instructions.

Communication

For discussions, questions, or support, please use the GitHub Issues section. Please be respectful and open to feedback from other contributors.

Pull Requests

PRs will be reviewed by project maintainers. Please be patient and open to feedback.

Code Review

Expect feedback on your Pull Request. Be open to making necessary changes or improvements as requested by the maintainers.

Attribution

All contributors will be credited in the project's acknowledgment section.