Welcome to report Issues or send pull requests. It's recommended to read the following Contributing Guide first before contributing.
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.
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.
We strongly welcome your pull request to make Caelus better.
There are two main branches here:
-
master branch
The developing branch. We welcome bugfix, features, typo and whatever on this branch.
-
branch-* branch
The releasing branch. It is our stable release branch. You are recommended to submit bugfix only to these branches.
The code team will monitor all pull request. Before submitting a pull request, please make sure the followings are done:
- Fork the repo and create your branch from master.
- Update code or documentation if you have changed APIs.
- Check your code lints and checkstyles.
- Test your code.
- Submit your pull request to master branch.
We use gofmt to check code styles. Make sure gofmt cmd/... pkg/... contrib/... passes
Caelus is under the Apache License 2.0. See the License file for details.