Skip to content

Latest commit

 

History

History
55 lines (38 loc) · 2.21 KB

CONTRIBUTING.md

File metadata and controls

55 lines (38 loc) · 2.21 KB

Contributing to Aeraki

Welcome to Aeraki! You are welcome to report Issues or pull requests. It's recommended to read the following Contributing Guide first before contributing.

Issues

We use Github issues to track public bugs and feature requests.

Search Known Issues First

Please search the existing issues to see if any similar issue or feature request has already been filed. You should make sure your issue isn't redundant.

Reporting New Issues

If you open an issue, the more information the better. Such as detailed description, screenshot or video of your problem, logcat or code blocks for your crash.

Pull Requests

We strongly welcome your pull request to make Aeraki better.

Make Pull Requests

The code team will monitor all pull request, we run some code check and test on it. After all tests passed, we will accept this PR. But it won't merge to master branch at once, which have some delay.

Before submitting a pull request, please make sure the followings are done:

  1. Fork the repo and create your branch from master.
  2. Update code or documentation if you have changed APIs.
  3. Add the copyright notice to the top of any new files you've added.
  4. Check your code lints and checkstyles.
  5. Test and test again your code.
  6. Now, you can submit your pull request on dev.

Sign the CLA

You must sign the Contributor License Agreement in order to contribute.

License

By contributing to Aeraki, you agree that your contributions will be licensed under its Apache v2 License.