Skip to content

Latest commit

 

History

History
65 lines (41 loc) · 3.15 KB

CONTRIBUTING.md

File metadata and controls

65 lines (41 loc) · 3.15 KB
Raw

Contributing to ZoneOut

First off, thank you for taking the time to contribute! 🎉👍

The following is a set of guidelines for contributing to ZoneOut, which is hosted on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report for ZoneOut. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.

Before creating a bug report, please check if the issue has already been reported. When you are creating a bug report, please include as many details as possible. Fill out the required template, the information it asks for helps us resolve issues faster.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for ZoneOut, including how to provide a clear and detailed explanation of the enhancement and its benefits.

Before creating enhancement suggestions, please check the list of issues to see if it has already been suggested. When you are creating an enhancement suggestion, please include as many details as possible. Fill out the feature request template, including the steps that you imagine you would take if the feature you're requesting existed.

Your First Code Contribution

Unsure where to begin contributing to ZoneOut? You can start by looking through these beginner and help-wanted issues:

Pull Requests

The process described here has several goals:

  • Maintain ZoneOut's quality
  • Fix problems that are important to users
  • Engage the community in working toward the best possible ZoneOut
  • Enable a sustainable system for ZoneOut's maintainers to review contributions

Please follow these steps to have your contribution considered by the maintainers:

  1. Fork the repository and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints.
  6. Issue that pull request!

Code Style

Please follow the coding style guidelines of the project. Ensure your code passes the existing linting and formatting rules by running:

npm run lint

Community and Support

Submit an Issue:

If you encounter any issues, please report them here. Join the discussion and stay updated with the latest news by following our Twitter account.

License

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

Thank You! Thank you for your interest in contributing to ZoneOut! We value all our contributors and are eager to work with you to improve our project.

Happy coding!🎉🎉