Skip to content

Latest commit

 

History

History
69 lines (49 loc) · 2.18 KB

CONTRIBUTING.md

File metadata and controls

69 lines (49 loc) · 2.18 KB
Raw

Contributing

Thank you for taking the time to contribute to elastic-builder! Your work is truly appreciated.

Please follow this guide to make that PR the best that it can be!

Guidelines

  • Write small commits with concise, descriptive messages.
  • Include tests for any new feature, and regression tests for any bug fix.
  • Write es2015+ javascript.
  • Try to keep the code style consistent. Follow existing patterns.
  • Modify or add to the README if your feature needs instructions on how to use it.

Development

Fork, then clone the repo:

git clone https://github.com/your-username/elastic-builder.git

Install dependencies using npm (install node.js first if necessary).

npm install

Write code

Typically, your changes will go in the src directory (the lib directory contains transpiled babel code) and the test directory.

No need to generate the built files, these will be added when a new version of elastic-builder is published to npm.

Run tests

This project uses eslint for javascript linting and ava for testing. Run linting using npm run lint and run tests using npm test. Or run both using:

npm run check

This should take care of formatting as well thanks to eslint-plugin-prettier.

(Optional) Add yourself as a contributor

Thanks for contributing! Go ahead and add yourself to the list of contributors in the npm package manifest package.json.

Submit your PR

This is the last step! Make sure your PR is aimed to merge with the master branch.

You should also write a good PR message with information on why this feature or fix is necesary or a good idea. For features, be sure to include information on how to use the feature; and for bugs, information on how to reproduce the bug is helpful!

Need help?

If you have any questions about the feature or fix you want to make, or if you have doubts about the approach, or anything else you're not sure about, the best way to get in touch is to open an issue. I am happy to help out.