Skip to content

Latest commit

 

History

History
101 lines (83 loc) · 4.71 KB

CONTRIBUTING.md

File metadata and controls

101 lines (83 loc) · 4.71 KB
Raw

Table of Contents

Contributing to ONIE

This section describes how to participate in the ONIE project.

Open Source Development Process

The description is somewhat informal, but captures the spirit of the effort. It is based on how other projects (Linux kernel and U-Boot, for example) manage.

Please read The Lifecycle of a Patch.

Here is how git "open source" development works. For nearly everything written below, you could replace the word "ONIE" with "Linux kernel".

  1. There is a public git repo for ONIE.
  2. A few people have commit privilege to the repo, also known as "maintainers" or "custodians" -- at the moment for ONIE that's a few people from Cumulus Networks and a few people from Big Switch.
  3. The entire world has read privilege to the repo.
  4. People without commit privilege want to contribute (a hardware vendor for example), called a "contributor". They open a discussion around their problem on the mailing list.
  5. Next the contributor makes a patch and sends it to the mailing list, including a maintainer. That patch must apply cleanly to the master branch.
  6. The maintainer, mailing list and contributor kick the patch around, look it over, make some changes, goes through some revisions.
  7. Eventually the patch is deemed acceptable and a maintainer applies the patch to the git repo.
  8. The patch contains all the attribution information. The git history will show that the contributor made the patch and changes. The maintainer merely applied the patch to the repo.

After the patch is applied it will be available in the common ONIE code base for everyone.

Step #6 can seem kind of brutal at first -- your code gets beat up in public on the mailing list. But it is not personal. It is all about code quality, sound design and being open.

General Patching Philosophy

One of the ONIE project goals is to maintain high standards for software quality and engineering discipline. In that spirit, here are some general comments regarding patch submission:

  1. Each patch should only contain one logical change. A patch should not contain multiple, unrelated changes.

  2. Each patch must apply cleanly to the master branch.

  3. Each patch must have the following:

  4. The author must be a real person with a valid email address. No anonymous github user IDs.

  5. A short one line summary. When the patch is for a specific machine include the machine name or company as a prefix to the summary, e.g.:

    machine_xyz_123: Update installer config

  6. What problem the patch solves (why do we need the patch).

  7. How you tested the patch.

  8. To upstream patches please use GitHub git pull requests. The ONIE project is following the fork and pull model.

    Note

    The author must be a real person with a valid email address. No anonymous github user IDs.

    Please do not create pull requests using your master branch. You should create a topic branch and make a pull request from that branch.

    This is described here: Creating a Pull Request and Using Pull Requests.

    As it says in the article "These changes are proposed in a branch, which ensures that the master branch is kept clean and tidy."

  9. Alternatively to upstream patches, send patches to the mailing list using the output of git format-patch. This ensures the patch is appropriately attributed to you.

  10. Information on the mailing list: https://ocp-all.groups.io/g/OCP-ONIE

  11. Follow these guidelines: https://www.kernel.org/doc/html/v5.11/_sources/process/email-clients.rst.txt

  12. Using git send-email is strongly recommended to avoid encoding problems

  13. Inline text patches are preferred as we can comment directly in email replies (avoid attachments)

  14. Attachments of types other than text/plain will not be accepted.

Pull requests can be easier to use then sending patches via email, as some email client mangle patch attachments.