| 1 | # How to contribute
|
| 2 |
|
| 3 | We're always happy about useful new pull requests. Keep in mind that the better
|
| 4 | your pull request is, the easier it can be added to `xml2js`. As such please
|
| 5 | make sure your patch is ok:
|
| 6 |
|
| 7 | * `xml2js` is written in CoffeeScript. Please don't send patches to
|
| 8 | the JavaScript source, as it get's overwritten by the CoffeeScript
|
| 9 | compiler. The reason we have the JS code in the repository is for easier
|
| 10 | use with eg. `git submodule`
|
| 11 | * Make sure that the unit tests still all pass. Failing unit tests mean that
|
| 12 | someone *will* run into a bug, if we accept your pull request.
|
| 13 | * Please, add a unit test with your pull request, to show what was broken and
|
| 14 | is now fixed or what was impossible and now works due to your new code.
|
| 15 | * If you add a new feature, please add some documentation that it exists.
|
| 16 |
|
| 17 | If you like, you can add yourself in the `package.json` as contributor if you
|
| 18 | deem your contribution significant enough. Otherwise, we will decide and maybe
|
| 19 | add you.
|