Skip to content

Latest commit

 

History

History
55 lines (30 loc) · 3.56 KB

CONTRIBUTING.md

File metadata and controls

55 lines (30 loc) · 3.56 KB

Contributing to elasticsearch

Elasticsearch is an open source project 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 which can be incorporated into Elasticsearch itself.

Contributing to elasticsearch-support-diagnostics

Repository: https://github.com/elasticsearch/elasticsearch-support-diagnostics

Bug reports

If you think you have found a bug in this plugin, first make sure that you are testing against the latest version - your issue may already have been fixed. If not, search our issues list on GitHub in case a similar issue has already been opened.

It is very helpful if you can prepare a reproduction of the bug. In other words, provide a small test case which we can run to confirm your bug. It makes it easier to find the problem and to fix it.

Feature requests

If you find yourself wishing for a feature that doesn't exist in this plugin, check the GitHub issues to see if it was already requested. If not, open an issue on GitHub which describes the feature you would like to see, why you need it, and how it should work.

Contributing code and documentation changes

If you have a bugfix or new feature that you would like to contribute to this plugin, 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.

We enjoy working with contributors to get their code accepted. There are many approaches to fixing a problem and it is important to find the best approach before writing too much code.

Fork and clone the repository

You will need to fork the elasticsearch-support-diagnostics code and clone it to your local machine. See github help page for help.

Submitting your changes

Once your changes and tests are ready to submit for review:

  1. Test your changes This project doesn't have a test suite yet, but please run the plugin and test your changes before submitting them.

  2. 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.

  3. Submit a pull request Push your local changes to your forked copy of the repository and submit a pull request. In the pull request, describe what your changes do and mention the number of the issue where discussion has taken place, eg "Closes #123".

Then sit back and wait. There will probably be discussion about the pull request and, if any changes are needed, we would love to work with you to get your pull request merged into Elasticsearch.

Source: Contributing to elasticsearch