DOC: add CONTRIBUTING.md adapted from DataLad#77
Open
lobennett wants to merge 1 commit intoexpfactory:mainfrom
Open
DOC: add CONTRIBUTING.md adapted from DataLad#77lobennett wants to merge 1 commit intoexpfactory:mainfrom
lobennett wants to merge 1 commit intoexpfactory:mainfrom
Conversation
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
1 participant
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.
This PR adds a
CONTRIBUTING.mdat the repo root covering the fork-based contribution workflow, branch/commit naming conventions, the pre-PR checklist, and merge cleanup steps for contributors.Structure and conventions (branch prefixes
nf-/bf-/rf-/doc-/bm-, commit prefixesNF:/BF:/RF:/DOC:/BM:/TST:/CI:/UX:/BK:, fork + PR workflow) are adapted from DataLad's CONTRIBUTING guide and credited in the Attribution section at the top of the file.The file points to
README.rstfor setup instructions and.pre-commit-config.yamlfor the existing ruff hooks, so it complements rather than duplicates existing docs.Happy to adjust conventions, scope, or tone if you'd prefer different choices for the project.