Our project welcomes external contributions! If you have an itch, please feel free to scratch it.
To contribute code or documentation, please submit a pull request to the GitHub repository.
A good way to familiarize yourself with the codebase and contribution process is to look for and tackle low-hanging fruit in the issue tracker. Before embarking on a more ambitious contribution, please quickly get in touch with us.
We appreciate your effort, and want to avoid a situation where a contribution requires extensive rework (by you or by us), sits in the queue for a long time, or cannot be accepted at all!
If you would like to implement a new feature, please raise an issue before sending a pull request so the feature can be discussed. This is to avoid you spending your valuable time working on a feature that the project developers are not willing to accept into the code base.
If you would like to fix a bug, please raise an issue before sending a pull request so it can be discussed. If the fix is trivial or non controversial then this is not usually necessary.
The project maintainers use LGTM (Looks Good To Me) in comments on the code review to indicate acceptance. A change requires LGTMs from two of the maintainers of each component affected.
For more details, see the MAINTAINERS page.
Please feel free to connect with us: here
Follow the "Run locally" steps and you will have a local git repo and test environment, or use "Deploy to Bluemix" and you can use the Bluemix DevOps environment.
Alternatively, you can also combine a local environment with a Cloudant service created by "Deploy to Bluemix". Just grab the Cloudant URL to use when you register replication.
Refer to the "Running the tests" section of the README.md.
We use eslint to enforce coding style guidelines. Use "npm run lint" to check your style.