Skip to content

Latest commit

 

History

History
55 lines (41 loc) · 2.61 KB

CONTRIBUTING.md

File metadata and controls

55 lines (41 loc) · 2.61 KB
Raw

Contributing to ndctl

Thank you for taking the time to contribute to ndctl.

The following is a set of guidelines that we adhere to, and request that contributors follow.

  1. NOTE: Since cxl-cli and libcxl are part of the ndctl project, any changes or questions relevant to CXL should also CC the CXL mailing list [email protected].

  2. The libnvdimm (kernel subsystem) and ndctl developers primarily use the nvdimm mailing list for everything. It is recommended to send patches to [email protected] and CC [email protected] if needed. The archives are available on nvdimm and cxl

  3. Github issues are an acceptable way to report a problem, but if you just have a question, email the above list and CC linux-cxl@[email protected] if needed.

  4. We follow the Linux Kernel Coding Style Guide as applicable.

  5. We follow the Linux Kernel Submitting Patches Guide as applicable.

  6. We follow the Linux Kernel DCO (Developer Certificate of Origin). The DCO is an attestation attached to every contribution made by every developer. In the commit message of the contribution, the developer simply adds a Signed-off-by statement and thereby agrees to the DCO.

  7. Github Pull Requests are acceptable mainly for smaller, more obvious fixups, but won't be merged directly, as Github doesn't allow for the kernel style flow of patches where a maintainer also signs off on the patches they apply. Larger changes may need to be sent to the mailing list so that everyone gets an opportunity to review them.

  8. Misc Best Practices:

    1. Use a subject prefix of "ndctl PATCH" (or "ndctl PATCH vN" for a new revision). This can be automated for a git format-patch command by setting a repo-local git config setting: git config format.subjectprefix "ndctl PATCH"

    2. For commit messages: Describe the change and why it was needed. Use a concise subject line, and a blank line between the subject and the body, as well as between paragraphs. Use present tense and the imperative mood (e.g. "Add support for.." instead of "Added support.." or "Adding support"). Word-wrap to 72 columns.