We want to make contributing to this project as easy and transparent as possible.
We will do our best to keep master in good shape, with tests passing at all times. But we will sometimes make API changes that your application might not be compatible with. We will do our best to communicate these changes and always version appropriately so you can lock into a specific version if need be.
We actively welcome your pull requests.
- Fork the repo and create your branch from
master. - If you've added code that should be tested, add tests.
- If you've changed APIs, update the documentation.
- Ensure the test suite passes.
- Make sure your code lints and is formatted with
prettier. Setupprettierfor better development practice in your editor
Please file issues liberally. That's the easiest way to contact us in a way that ensures everyone working on. We are eager for your questions, input, and to hear about your experience.
We use GitHub issues to track public bugs. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue.
By contributing to GoldenSwan, you agree that your contributions will be licensed under the LICENSE file in the root directory of this source tree.