doc: consolidate contributor guidance into CONTRIBUTING.md#3265
Merged
igaw merged 1 commit intolinux-nvme:masterfrom Apr 10, 2026
Merged
doc: consolidate contributor guidance into CONTRIBUTING.md#3265igaw merged 1 commit intolinux-nvme:masterfrom
igaw merged 1 commit intolinux-nvme:masterfrom
Conversation
igaw
reviewed
Apr 10, 2026
Collaborator
|
Rest looks great! |
martin-belanger
force-pushed
the
update-contributing
branch
from
baa2c2a to
f4c6550
Compare
igaw
reviewed
Apr 10, 2026
README.md was mixing user-facing content (build instructions, configuration, distro support) with developer-facing content (how to add commands, how to add plugins, API naming conventions, PR workflow). Readers looking to contribute had no obvious starting point. Move the three developer-facing sections — "Developers", "API naming conventions", and "How to contribute" — into CONTRIBUTING.md, where they join and supersede the existing commit-conventions and bug-report stubs. Replace all three sections in README.md with a short "Contributing" paragraph that links to CONTRIBUTING.md. While reorganizing CONTRIBUTING.md, document the new API naming convention (libnvme_/libnvmf_ for libnvme, nvme_/nvmf_ for nvme-cli) so contributors know which prefix to use when adding new functions. Signed-off-by: Martin Belanger <martin.belanger@dell.com>
martin-belanger
force-pushed
the
update-contributing
branch
from
f4c6550 to
fac8679
Compare
Collaborator
|
Thanks a lot! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
README.mdwas mixing user-facing content (build instructions, configuration, distro support) with developer-facing content (how to add commands, how to add plugins, API naming conventions, PR workflow). Readers looking to contribute had no obvious starting point.Move the three developer-facing sections — "Developers", "API naming conventions", and "How to contribute" — into
CONTRIBUTING.md, where they join and supersede the existing commit-conventions and bug-report stubs. Replace all three sections inREADME.mdwith a short "Contributing" paragraph that links toCONTRIBUTING.md.While reorganizing
CONTRIBUTING.md, document the new API naming convention (libnvme_/libnvmf_for libnvme,nvme_/nvmf_for nvme-cli) so contributors know which prefix to use when adding new functions.