Skip to content

Latest commit

 

History

History
53 lines (41 loc) · 1.65 KB

CONTRIBUTING.md

File metadata and controls

53 lines (41 loc) · 1.65 KB

Contributing

I am open to, and grateful for, any contributions made by the community. By contributing to Hydra, you agree to abide by the code of conduct.

Development

Visit the issue tracker to find a list of open issues that need attention.

Fork, then clone the repo:

git clone https://github.com/your-username/hydra.git

Building Building Hydra Running the build task will create a CommonJS module-per-module build, a ES Modules build and a UMD build.

npm run build

Testing and Linting To only run linting:

npm run lint

To only run tests:

npm run test

To continuously watch and run tests, run the following:

npm run test:watch

Docs

Improvements to the documentation are always welcome. You can find them in the docs path.

Sending a Pull Request

For non-trivial changes, please open an issue with a proposal for a new feature or refactoring before starting on the work. We don't want you to waste your efforts on a pull request that we won't want to accept.

On the other hand, sometimes the best way to start a conversation is to send a pull request. Use your best judgement!

In general, the contribution workflow looks like this:

Open a new issue in the Issue tracker.

Fork the repo. Create a new feature branch based off the master branch. Make sure all tests pass and there are no linting errors. Submit a pull request, referencing any issues it addresses. Please try to keep your pull request focused in scope and avoid including unrelated commits.

After you have submitted your pull request, we'll try to get back to you as soon as possible. We may suggest some changes or improvements.

Thank you for contributing!