Contribution Guidelines

Welcome to the Xero-Node Wiki!

This provides an overview of how to contribute to this library.

If you're looking to use the library within your project, check out the Creating an SDK Client or Sample App Setup docs within the repo.

Please follow the instructions below to submit your code. This will make a happier place for everyone involved.

Library Compatibility

This library has been built to support Node.js v6.0.0 and above. If you are implementing any new functionality, please make sure it is compatible with Node v6.0.0.

Where possible, please use standard node functions over external libraries (such as lodash). If no suitable function exists, import the external library using Yarn.

Implementing New Features or Fixing Bugs

If you want to implement a new feature and you would like it to be assessed and merged, please fork the code to your own repository, implement the feature and submit a PR.

Before submitting your PR please ensure you've checked the following list:

1. Have you implemented tests for your new feature and ensured they run using npm test?
2. Have you checked the code coverage for your tests is at least 80%?
3. Have you modified/improved a method that could be applied to other methods to ensure consistency?
4. Have you added/updated the appropriate file in the docs directory?
5. Have you updated the sample application to support your new feature?

If you've answered all of these and still want to submit the PR please push to this repo and it'll be reviewed and merged by one of our team.

If you need further support, please raise an issue in Github or contact api@xero.com.