DEV Community

Agney Menon
Agney Menon

Posted on

Adding Contributing Files

With the growing interest from new programmers with #hacktoberfest, I decided to add a Contributing.md to my repositories.

This is what I came up with.

GitHub logo agneym / json-formatter

An extensible JSON Viewer, Editor, Formatter, Validator based on Monaco Editor

JSON Crew

All Contributors

badge Netlify Status code style: prettier

PRs Welcome first-timers-only Friendly

An extensible JSON Viewer, Editor, Formatter and Validator that works completely on the client side.

Features

  1. JSON Viewer & Editor
  2. JSON Formatting with options.
  3. JSON Validation with respect to readily available schemas (with option to bring your own schema)
  4. PWA - You can install this directly from your browser.
  5. Upload JSON from your system or load directly from URL
  6. Download formatted JSON
  7. Share JSON with peer to peer
  8. Search & Replace words/expressions with support for case matching, regular expressions
  9. Multi-cursor editing support
  10. Editor theming support
  11. Supports Plugins to extend Functionality.

How to create a JC Plugin

JSON Crew Plugin system is based on Web Components.

It gives the JSON data entered by the user as input to the web component and allows it to render the UI for plugin area. From here, you can transform the JSON and emit a custom event json-transform with transformed JSON as theโ€ฆ




What do you guys think? Is there anything more you would like to see?

How can we do better to be in the shoes of a new developer trying to contribute?

Top comments (0)