Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
53 lines (32 loc) · 2.75 KB

CONTRIBUTING.md

File metadata and controls

53 lines (32 loc) · 2.75 KB

Contributing to JSONViewer for Chrome

First off, thank you for considering contributing to JSONViewer for Chrome. It's people like you that make the open source community such a fantastic place to learn, inspire, and create. Any contributions you make will benefit everybody else and are greatly appreciated.

What types of contributions are we looking for?

We are looking for contributions of all kinds, including:

  • Bug Reports: Identify and report issues that you encounter to help us make our project more stable.
  • Feature Requests: Have an idea for a new feature or an enhancement to an existing feature? We'd love to hear it!
  • Code Contributions: Interested in fixing a bug or adding a new feature? Check our issue tracker for open issues or suggest your ideas.
  • Documentation Improvements: Spotted a typo? Or think something could be more clear? Contributions to the documentation are very welcome.

How to Contribute

If you'd like to contribute, start by searching through the issues and pull requests to see whether someone else has raised a similar idea or question.

If your idea is new, and you think it fits with the scope of the project, do the following:

  1. Fork the repository on GitHub.
  2. Clone the forked repository to your own machine.
  3. Commit changes to your own branch. Make sure your code adheres to the existing style of the project to best match the overall project aesthetics.
  4. Push your work back up to your fork.
  5. Submit a Pull request so that we can review your changes. Be sure to include a descriptive title and a summary of your changes.

Reporting Bugs

When reporting bugs, include as many details as possible. Fill out the provided template with a clear description of the issue, steps to reproduce, expected behavior, screenshots if applicable, and any other information that might be relevant.

Suggesting Enhancements

For enhancement suggestions, please provide a clear description of the feature you would like to see, its potential benefits, and any examples of how it would work.

Pull Request Guidelines

Before submitting a pull request, check that it meets these guidelines:

  1. The pull request should include tests that cover the changes made.
  2. If you've changed APIs, update the documentation.
  3. Ensure the test suite passes.
  4. Make sure your code lints.

Code of Conduct

Participation in the project is governed by our Code of Conduct. Please read it so that you know what behaviors will and will not be tolerated.

Questions?

Don't hesitate to reach out if you have any questions. You can open an issue or contact the project maintainers directly.

Thank you for contributing to JSONViewer for Chrome!