dCDN
Integration status
How to contribute
- Prepare your dev environment
- Deal with an issue
- Go into development mode
How to prepare your dev environment
- Fork the repo
- Clone your fork onto a dev machine running Mac OS X or Ubuntu
./build.sh && ./test.sh- If this fail, read
.travis.ymland do what it does to build - When your build works and tests pass, you're ready to contribute
How to deal with an issue
- Get an issue assigned by @shalunov
- Work on the issue in your forked repo
- If you like feature branches, you can do that
- When you're satisfied with your changes, send a pull request and tag the issue the end of the title
- Wait for CI checks to complete on the pull request; if they fail, you'll need to revise
- If code review is requested, wait for the reviewer to provide one
- If the reviewer requests revisions, discuss, address, and probably revise
- When your pull request is merged, double-check the CI status on the merge commit before celebrating
How to go into development mode
In development mode, you deal with issues one after another, and maintain enough pipeline so you're not just waiting for reviews, merges, and assignments. This normally means having a backup issue assigned; this way, after you're done with the issue you're working on and send a pull request, you can work on the other issue. Feature branches make it more convenient to work on multiple issues like that.
You may be asked to review a merge request. Please try to be timely with your review. Be kind, but firm in your review: we want things to be the best we can make them, but we are also a community. When providing the review, always make it very clear whether you think the pull request should be merged—start your review with
Coding style
- Follow existing coding style, including
.clang-format - Name things after what they are
- The smallest changeset that addresses the issue is best
- Keep related things close