Skip to content

Latest commit

 

History

History
51 lines (36 loc) · 2.22 KB

CONTRIBUTING.md

File metadata and controls

51 lines (36 loc) · 2.22 KB
Raw

Contributing to the Enterprise Search Node.js and browser clients

The Enterprise Search Node.js and browser clients are open source and we love to receive contributions from our community — you!

There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests or writing code.

Code contributions

If you have a bugfix or new feature that you would like to contribute, please find or open an issue about it first. Talk about what you would like to do. It may be that somebody is already working on it, or that there are particular issues that you should know about before implementing the change.

Note that we strictly follow the Elastic EOL schedule.

Submitting your changes

Generally, we require that you test any code you are adding or modifying. Once your changes are ready to submit for review:

  1. Test your changes

    Run the test suite to make sure that nothing is broken. Usually run npm test is enough, our CI will take care of running the integration test. If you want to run the integration test yourself, see the Testing section below.

  2. Submit a pull request

    Push your local changes to your forked copy of the repository and submit a pull request. In the pull request, choose a title which sums up the changes that you have made, and in the body provide more details about what your changes do. Also mention the number of the issue where discussion has taken place, eg "Closes #123".

  3. Sign the Contributor License Agreement

    Please make sure you have signed our Contributor License Agreement. We are not asking you to assign copyright to us, but to give us the right to distribute your code without restriction. We ask this of all contributors in order to assure our users of the origin and continuing existence of the code. You only need to sign the CLA once.

  4. Be patient

    We might not be able to review your code as fast as we would like to, but we'll do our best to dedicate it the attention it deserves. Your effort is much appreciated!