For those who wish to contribute to this project, here are some guidelines.
Fork, then clone the repo:
git clone [email protected]:your-username/rosette-elasticsearch-plugin.git
Set up your environment:
- Java 8
- Maven
- Get a Rosette API key if you don't have one
- export ROSETTE_API_KEY="<your key>"
Make sure you can successfully build and tests pass:
mvn clean install
Make your change. Add tests for your change. Make sure everything still passes:
mvn clean install
Push to your fork and submit a pull request.
We'll take a look and may suggest some changes or improvements or alternatives.
To increase the chance that your pull request is accepted, make sure to write tests, clean commented code, and good commit messages.