Skip to content

Commit

Permalink
Add Contributing Guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
bhollis committed Nov 29, 2014
1 parent e511d4f commit d2d2cac
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 1 deletion.
19 changes: 19 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
Contributing to JSONView
---

The goal of JSONView is to be a very simple, straightforward add-on that formats JSON. Given that, even though I'm very appreciative of the time and thought put into contributions, I regularly reject them because they add complexity to the add-on that I don't think should be there. Please consider [filing an issue](https://github.com/bhollis/jsonview/issues) before doing any work, so you don't accidentally waste time on something I won't accept.

There are no hard and fast rules for what I will and will not accept - please just ask via an issue before implementing. Generally, things I have rejected in the past:

* Adding new MIME types to the set supported by JSONView. I have [an open issue](https://github.com/bhollis/jsonview/issues/7) for how I'd like to see additional MIME types handled, and will not accept patches that add arbitrary new MIME types.
* Adding new options. While I'm not opposed to adding an option if it really makes sense, the bar is very high for adding anything configurable to the add-on.
* Interpreting JSON in any application-specific way. While in the past I've allowed a few feature additions that attempt to interpret JSON (such as recognizing and linkifying URLs), I want JSONView to be a general JSON viewer, and as such will reject any patch that seeks to priviledge specific interpretations of JSON structure.
* Adding switches or options to the screen that shows JSON. I don't want to clutter up the JSON view itself with control panels and options, so anything that relies on adding such a thing is likely to be rejected.

Please, don't let this discourage you! Just file an issue first so we can discuss the change you plan to make.


Code Guidelines
---

Please match the formatting of existing code - that includes whitespace, documentation, code style, and naming conventions. Look at the code around your patch and just copy that style.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@ Use the GitHub [Issue tracker for JSONView](https://github.com/bhollis/jsonview/

Developing JSONView
-------------------

Before contributing to JSONView, make sure to read the [Contributing Guidelines](CONTRIBUTING.md). I appreciate contributions people make to JSONView, but the goal of the add-on is to be simple and straightforward, so I frequently reject contributions that add complexity or unnecessary features. Please consider filing an issue before doing any work, so you don't waste time on something I won't accept.

* Install [Add-on SDK](https://developer.mozilla.org/en-US/Add-ons/SDK)
* Make sure the SDK Virtual Environment is activated by running `cfx` from shell prompt.
* Run `python build.py run` or `cfx run` to test in Firefox.
Expand All @@ -28,9 +31,9 @@ The build script also comes with a HTTP server which can be used to test JSON fi

Unofficial Ports
----------------
* [jsonview-safari](https://github.com/acrogenesis/jsonview-safari)
* [jsonview-chrome](https://github.com/jamiew/jsonview-chrome)
* [jsonview-opera](https://github.com/fearphage/jsonview-opera)
* [jsonview-safari](https://github.com/acrogenesis/jsonview-safari)

Common Issues
-------------
Expand Down

0 comments on commit d2d2cac

Please sign in to comment.