Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jdorn committed Jul 29, 2014
1 parent 1bbe9ca commit 35ca167
Showing 1 changed file with 21 additions and 8 deletions.
29 changes: 21 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,44 @@
Contributing to JSON Editor
Contributing
===============
This document briefly lists the guidelines for contributing to JSON Editor.

Reporting Bugs
----------------
When creating an issue in GitHub, try to include when feasible:
* A brief description of the issue
* An example JSON schema that causes the issue
* Steps to reproduce

If you can reproduce the issue on the demo page (http://jeremydorn.com/json-editor/), it's helpful to attach the "Direct Link" url (top right of page). Note: the direct link might not work for very large schemas or JSON values.


Contributing Code
--------------------------
One of the major goals of JSON Editor is to be easy to modify and hack.

If you fix a bug or add a cool feature, plase submit a pull request!

This document briefly lists the guidelines for contributing to JSON Editor.

Code Style
-----------
### Code Style

* Use 2 spaces for indentation
* Use comments whenever the code's meaning is not obvious
* When in doubt, try to match the style in existing source files

Grunt
-----
###Grunt

The easiest way to hack on JSON Editor is to run `grunt watch`, which
re-builds `dist/jsoneditor.js` every time a source file changes.

To do a full grunt build which includes jshint and minification, run `grunt`.

Submitting Pull Requests
-----------------------
### Submitting Pull Requests
Try to limit pull requests to a single narrow feature or bug fix.

__Do not submit `dist/` files!__

The following is done when a pull request is accepted. There is no need to do any of these steps yourself.

1. Merge pull request into master
2. Increment version number in `src/intro.js` and `bower.json`. Set date in `src/intro.js`.
3. Build `dist/` files with grunt
Expand Down

0 comments on commit 35ca167

Please sign in to comment.