Skip to content

Latest commit

 

History

History
60 lines (39 loc) · 2.47 KB

CONTRIBUTING.md

File metadata and controls

60 lines (39 loc) · 2.47 KB
Raw

Contributing to react-json-grid

We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

  • Reporting an issue
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features

All Changes Happen Through Pull Requests

Pull requests are the best way to propose changes. We actively welcome your pull requests:

  1. Fork the repo and create your branch from master.
  2. If you've added code that should be tested, add some tests.
  3. Update the documentation in README.md if necessary.
  4. Issue that pull request!

Local Development

To run & test react-json-grid, you need to follow a few simple steps (you can use yarn instead of npm):-

  1. Fork the repository and clone the code to your local machine.
  2. Run npm install in the repository root and demo directory.
  3. Run npm link in the repository root. And then run npm link @redheadphone/react-json-grid in the demo directory.
  4. Run the command npm run dev to start the development server for react-json-grid package. And run npm run demo to start the demo server at http://localhost:5173.

Any contributions you make will be under the MIT Software License

In short, when you submit changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.

Report issues/bugs using GitHub's issues

We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!

Bug Reports

Great Bug Reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce
    • Be specific!
    • Share the snapshot, if possible.
  • What actually happens
  • What you expected would happen
  • Notes (possibly including why you think this might be happening or stuff you tried that didn't work)

People love thorough bug reports. I'm not even kidding.

Feature Request

Great Feature Requests tend to have:

  • A quick idea summary
  • What & why do you want to add the specific feature
  • Additional context like images, links to resources to implement the feature, etc.

License

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