Skip to content

Latest commit

 

History

History
58 lines (35 loc) · 1.82 KB

CONTRIBUTE.md

File metadata and controls

58 lines (35 loc) · 1.82 KB
Raw

Contributing to osfci

We need help with this project. Contributions are very welcome. See open issues.

Bugs and Ideas

Please submit to https://github.com/opencomputeproject/OSF-OSFCI/issues

Discussions and get in touch with us!

Please get in touch via https://github.com/opencomputeproject/OSF-OSFCI/discussions

Coding Style

The osfci project aims to follow the standard formatting recommendations and language idioms set out in the Effective Go guide, for example formatting and names.

gofmt and golint are required and will be checked during code-review.

  • Example(s): 
    a) for single file

gofmt -s -w ctrl1.go
golint ctrl1.go

b) for whole project folder - this will show changed files as well

gofmt -l -s -w .

Pull Requests

We accept GitHub pull requests.

Fork the project on GitHub, work in your fork and in branches, push these to your GitHub fork, and when ready, do a GitHub pull requests against https://github.com/opencomputeproject/OSF-OSFCI.

Every commit in your pull request needs to be able to build and pass our CI tests.

Also, we are DCO compiliant so please ensure sign-off is done appropriately.

Code Reviews

Look at the area of code you're modifying, its history, and consider tagging some of the maintainers when doing a pull request in order to instigate some code review.

Quality Controls

Testing by the Advanced Technology Team and contributors.

References

This document is inspired by standards followed by https://github.com/u-root/u-root