Skip to content

Latest commit

 

History

History
97 lines (62 loc) · 4.2 KB

CONTRIBUTING.md

File metadata and controls

97 lines (62 loc) · 4.2 KB

Contributing to ZenRead

First off, thank you for considering contributing to ZenRead! It's people like you that make ZenRead such a great tool.

Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.

Quicklinks

ZenRead's Development Philosophy

We are an open source, community-driven project. We believe in the power of collaboration and the importance of creating a welcoming and inclusive environment for all contributors.

What We Are Looking For

There are many ways you can contribute to ZenRead, such as:

  • Bug Reports: Provide detailed reports of any bugs you encounter.
  • Feature Suggestions: Suggest new features or enhancements.
  • Code Contributions: Submit pull requests for bug fixes or feature implementations.
  • Documentation: Help improve or translate the documentation.
  • User Support: Help answer questions from other users.
  • Code Review: Participate in code reviews and help test new features and bug fixes.

How to Contribute

If you're ready to contribute to ZenRead, here's how to set up the project for local development:

  1. Fork the ZenRead repo on GitHub.

  2. Clone your fork locally:

    git clone git@github.com:desmondezo1/ZenRead.git

  3. Create a branch for local development:

    git checkout -b name-of-your-bugfix-or-feature

    Now you can make your changes locally.

  4. Commit your changes and push your branch to GitHub:

    git add .
git commit -m "Your detailed description of your changes."
git push origin name-of-your-bugfix-or-feature

  5. Submit a pull request through the GitHub website using the template provided.

Setting Up Chrome Extension Environment

To set up the ZenRead Chrome extension for development and testing:

  1. Navigate to chrome://extensions/ in the Google Chrome browser.
  2. Enable 'Developer mode' at the top right corner.
  3. Click 'Load unpacked' and select the dist or build folder from the cloned ZenRead repository.
  4. The ZenRead extension should now be installed in your Chrome browser for development testing.

How to Report a Bug

If you find a security vulnerability, do NOT open an issue. Email desmondezoojile@gmail.com instead.

If you're reporting a non-critical issue, follow these steps:

  • Use the GitHub issue search — check if the issue has already been reported.
  • If the issue has not been reported, open a new issue.
  • Provide a clear title and description.
  • Include as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

How to Suggest a Feature or Enhancement

If you find yourself wishing for a feature that doesn't exist in ZenRead, you are probably not alone. There are bound to be others out there with similar needs. Open an issue on our issues list on GitHub which describes the feature you would like to see, why you need it, and how it should work.

Code of Conduct

Please note we have a Code of Conduct, please follow it in all your interactions with the project.

Community

Discussions about ZenRead take place on this repository's Issues and Pull Requests sections. Anybody is welcome to join these conversations.

Where possible, we use GitHub to track discussions. Other channels of communication (like personal emails, Twitter, and the like) should be used sparingly.

Once again, thanks for your interest in contributing to ZenRead. We appreciate your efforts and look forward to your contributions!