Skip to content

Latest commit

 

History

History
102 lines (70 loc) · 4.74 KB

CONTRIBUTING.md

File metadata and controls

102 lines (70 loc) · 4.74 KB
Raw

Contributing to Ciao

Ciao is an open source project licensed under the [Apache v2 License] (https://opensource.org/licenses/Apache-2.0)

Coding Style

Ciao follows the standard formatting recommendations and language idioms set out in the Effective Go guide. It's definitely worth reading - but the relevant sections are formatting and names.

Certificate of Origin

In order to get a clear contribution chain of trust we use the [signed-off-by language] (https://01.org/community/signed-process) used by the Linux kernel project.

Patch format

Beside the signed-off-by footer, we expect each patch to comply with the following format:

<component>: Change summary

More detailed explanation of your changes: Why and how.
Wrap it to 72 characters.
See [here] (http://chris.beams.io/posts/git-commit/)
for some more good advices.

Signed-off-by: <[email protected]>

For example:

ssntp: Implement role checking

SSNTP roles are contained within the SSNTP certificates
as key extended attributes. On both the server and client
sides we are verifying that the claimed roles through the
SSNTP connection protocol match the certificates.

Signed-off-by: Samuel Ortiz <[email protected]>

Pull requests

We accept github pull requests.

If you want to work on github.com/ciao-project/ciao and your fork on the same workstation you will need to use multiple GOPATHs. Assuming this is the case

  1. Open a terminal
  2. mkdir -p ~/go-fork/src/github.com/ciao-project (replacing go-fork with your preferred location)
  3. export GOPATH=~/go-fork
  4. cd $GOPATH/src/github.com/ciao-project
  5. git clone https://github.com/GITHUB-USERNAME/ciao.git (replace GITHUB-USERNAME with your username)
  6. cd ciao
  7. go install ./...

Once you've finished making your changes push them to your fork and send the PR via the github UI. If you don't need to maintain the github.com/ciao-project/ciao repo and your fork on the same workstation you can skip steps 2 and 3.

Quality Controls

We request you give quality assurance some consideration by:

  • Adding go unit tests for changes where it makes sense.
  • Using our test-cases package to run unit tests because a simple gotest ./... can result in multiple packages' unit tests running in parallel which may be unsafe. Simply replace go test with test-cases in your workflow.
  • Running basic cluster acceptance tests which are available in _release/bat and are most easily run inside a singlevm test environment, but may also be run on a hardware cluster which has your code installed/configured/running. In some cases it will be necessary to test on real hardware, but in many a virtual cluster is an easy and fully sufficient path to test.
  • Adding BAT tests for changes where it makes sense. The BAT tests themselves are implemented in go in the bat package, which is essentially a wrapper/driver around ciao-cli. Both the bat package and BAT tests are easy to extend.
  • Enabling Travis CI on your github fork of Ciao to get continuous integration feedback on your dev/test branches. We have thresholds on code coverage tracked by coveralls which you will see reported once you submit your pull request.

Issue tracking

If you have a problem, please let us know. IRC is a perfectly fine place to quickly and informally bring something up. The mailing list is a more reliable communication channel.

If it's a bug not already documented, by all means please open an issue in github so we all get visibility of the problem and work toward resolution.

For feature requests we're also using github issues, with the label "enhancement".

Closing issues

You can either close issues manually by adding the fixing commit SHA1 to the issue comments or by adding the Fixes keyword to your commit message:

ssntp: test: Add Disconnection role checking tests

We check that we get the right role from the disconnection
notifier.

Fixes #121

Signed-off-by: Samuel Ortiz <[email protected]>

Github will then automatically close that issue when parsing the commit message.