Skip to content

Latest commit

 

History

History
39 lines (24 loc) · 2.47 KB

CONTRIBUTING.md

File metadata and controls

39 lines (24 loc) · 2.47 KB
Raw

Contributing to QuietTube

Thank you for considering contributing to QuietTube! Your contributions help enhance the browsing experience for users seeking a distraction-free YouTube environment. Before you start, please take a moment to review the following guidelines.

How to Contribute

Contributions come in various forms, from reporting issues and suggesting enhancements to submitting pull requests with code changes. Here's how you can get involved:

  1. Report Issues: If you encounter a bug, inconsistency, or have a general suggestion, please open an issue on our issue tracker. Be sure to include a descriptive title and a clear explanation.

  2. Feature Requests: Feel free to propose new features or improvements by creating an issue on the issue tracker. Describe the feature's purpose and how it would benefit the QuietTube extension.

  3. Pull Requests: If you're interested in contributing code directly, fork the repository and create a pull request. Before submitting, ensure your code adheres to the existing coding style and passes tests. Provide a clear description of your changes and reference any related issues.

Getting Started

  1. Fork the repository by clicking the "Fork" button on the top right of the GitHub page.
  2. Clone your forked repository: git clone https://github.com/Mohsin-mw/QuietTube.git
  3. Create a new branch for your changes: git checkout -b feature-name
  4. Make your changes, following the coding style and guidelines.
  5. Commit your changes: git commit -m "Brief description of your changes"
  6. Push the changes to your forked repository: git push origin feature-name
  7. Create a pull request against the main branch of the original repository.

Code Quality and Guidelines

  • Follow the coding style and conventions already established in the project.
  • Write clear and concise commit messages.
  • Make sure your code is well-documented and includes comments where necessary.
  • Run tests locally to ensure your changes do not introduce regressions.

License

By contributing to QuietTube, you agree that your contributions will be licensed under the MIT License.

Contact

For questions or clarifications, please contact [email protected]. We appreciate your efforts and look forward to collaborating with you to make QuietTube even better!