Skip to content

Latest commit

 

History

History
135 lines (102 loc) · 5.75 KB

CONTRIBUTING.md

File metadata and controls

135 lines (102 loc) · 5.75 KB
Raw

Contributing to the NVM Library

Here you'll find instructions on how to contribute to the NVM Library.

Your contributions are most welcome! You'll find it is best to begin with a conversation about your changes, rather than just writing a bunch of code and contributing it out of the blue. There are several good ways to suggest new features, offer to add a feature, or just begin a dialog about the NVM Library:

  • Open an issue in our GitHub Issues Database
  • Suggest a feature, ask a question, start a discussion, etc. in our pmem Google group
  • Chat with members of the NVM Library team real-time on the #pmem IRC channel on OFTC

NOTE: If you do decide to implement code changes and contribute them, please make sure you agree your contribution can be made available under the BSD-style License used for the NVM Library.

NOTE: Submitting your changes also means that you certify the following:

Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

In case of any doubt, the gatekeeper may ask you to certify the above in writing, i.e. via email or by including a Signed-off-by: line at the bottom of your commit comments.

To improve tracking of who is the author of a contribution, we kindly ask you to use your real name (not an alias) when commiting your changes to the NVM Library:

Author: Random J Developer <random@developer.example.org>

Code Contributions

Please feel free to use the forums mentioned above to ask for comments & questions on your code before submitting a pull request. The NVM Library project uses the common fork and merge workflow used by most GitHub-hosted projects. The Git Workflow blog article describes our workflow in more detail.

Before contributing please remember to run:

	$ make cstyle

This will check all C/C++ files in the tree for style issues. To check C++ files you have to have clang-format version 3.8+, otherwise they will be skipped. There is also a target for automatic C++ code formatting, to do this run:

	$ make format

There are cases, when you might have several clang-format-X.Y binaries and either no clang-format or it pointing to an older version. In such case run:

	$ make CLANG_FORMAT=/path/to/clang-format cstyle|format

If you are actively working on an NVM Library feature, please let other developers know by creating an issue. Use the label Type: Feature and assign it to yourself (due to the way GitHub permissions work, you may need to ask a team member to assign it to you).

Bug Reports

Bugs for the NVM Library project are tracked in our GitHub Issues Database.

When creating a bug report issue, please provide the following information:

Milestone field

Put the release name of the version of NVML running when the bug was discovered in the Milestone field. If you saw this bug in multiple NVML versions, please put the most recent version in Milestone and list the others in a bug comment.

  • Stable release names are in the form #.# (where # represents an integer); for example 0.3.
  • Release names from working versions look like #.#+b# (adding a build #) or #.#-rc# (adding a release candidate number) If NVML was built from source, the version number can be retrieved from git using this command: git describe

For binary NVML releases, use the entire package name. For RPMs, use rpm -q nvml to display the name. For Deb packages, run dpkg-query -W nvml and use the second (version) string.

Type: Bug label

Assign the Type: Bug label to the issue (see GitHub Help for details).

Priority label

Optionally, assign one of the Priority labels (P1, P2, ...). The Priority attribute describes the urgency to resolve a defect and establishes the time frame for providing a verified resolution. These Priority labels are defined as:

  • P1: Showstopper bug, requiring resolution before the next release of the library.
  • P2: High-priority bug, requiring resolution although it may be decided that the bug does not prevent the next release of the library.
  • P3: Medium-priority bug. The expectation is that the bug will be evaluated and a plan will be made for when the bug will be resolved.
  • P4: Low-priority bug, the least urgent. Fixed as resources are available.

Then describe the bug in the comment fields.

Type: Feature label

Assign the Type: Feature label to the issue, then describe the feature request in comment fields.