Skip to content

Latest commit

 

History

History
53 lines (38 loc) · 2.43 KB

contributing.md

File metadata and controls

53 lines (38 loc) · 2.43 KB
Raw

Contributing to IndyKite

We want your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer

We Develop with GitHub

We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.

We Use GitHub Flow, So All Code Changes Happen Through Pull Requests

Pull requests are the best way to propose changes to the codebase (we use GitHub Flow). We actively welcome your pull requests:

  1. Fork the repo and create your branch from main / master.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints.
  6. Create that pull request!

Any contributions you make will be under the Apache-2.0 Software License

In short, when you submit code changes, your submissions are understood to be under the same Apache-2.0 that covers the project. Feel free to contact the maintainers if that's a concern.

Report bugs using GitHub's issues

We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!

Write bug reports with detail, background, and sample code

Including the following information will tend to make a better bug report:

  • A quick summary and/or background
  • Steps to reproduce. Be specific!
  • Give sample code if you can.
  • What you expected would happen
  • What actually happens
  • Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
  • Include version information such as browser, api, JS, etc

Please provide as much information as possible in your bug reports.

Use a Consistent Coding Style

For example:

  • 2 spaces for indentation rather than tabs
  • Default to the utf-8 character set

To make it easier to maintain a consistent coding style, we use a few plugins such as prettier, eslint and .editorconfig (which are supported by most of the popular IDEs)

License

By contributing, you agree that your contributions will be licensed under its Apache-2.0 License.