Skip to content
This repository has been archived by the owner on Jul 11, 2023. It is now read-only.

Latest commit

 

History

History
103 lines (70 loc) · 2.99 KB

CONTRIBUTING.md

File metadata and controls

103 lines (70 loc) · 2.99 KB
Raw

Contributing to u-root

We need help with this project. Contributions are very welcome. See the roadmap, open issues, and join us in Slack to talk about your cool ideas for the project.

Developer Sign-Off

For purposes of tracking code-origination, we follow a simple sign-off process. If you can attest to the Developer Certificate of Origin then you append in each git commit text a line such as:

Signed-off-by: Your Name <username@youremail.com>

Code of Conduct

Conduct collaboration in accordance to the Code of Conduct.

Communication

Bugs

Coding Style

The webboot 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 law, although this is not automatically enforced yet and some housecleaning needs done to achieve that.

We have a few rules not covered by these tools:

  • Standard imports are separated from other imports. Example: 
    import (
  "regexp"
  "time"

  dhcp "github.com/krolaw/dhcp4"
)

Patch Format

Well formatted patches aide code review pre-merge and code archaeology in the future. The abstract form should be:

<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: <contributor@foo.com>

An example from this repo:

tcz: quiet it down

It had a spurious print that was both annoying and making
boot just a tad slower.

Signed-off-by: Ronald G. Minnich <rminnich@gmail.com>

General Guidelines

Webboot aims to be able to boot (optionally) signed distros from URLs.

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/u-root/webboot.

webboot uses go modules. Do not clone webboot into your GOPATH. If you add new dependencies, use the appropriate go modules command to update things.

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

If the pull request closes an issue please note it as: "Fixes #NNN".

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

We use Azure pipelines for our CI.