doc(contributing) first few guidelines on doc, commits, and PRs #14
Conversation
This file contains 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
mih
force-pushed
the
guides
branch
4 times, most recently
from
4ce10b1
to
199eb88
Compare
mslw
approved these changes
Jun 6, 2024
There was a problem hiding this comment.
This sounds clear to me, and since I like the approach in DataLad-next, I like this one too.
I had to think a little when reading the description of sub-modules, sub-packages, and relative/absolute imports, but I think everything is described well and will be even clearer when looking at existing code.
I like the emphasis on self-contained series of commits. Since the commit message convention is described here, I'll leave a ping to current consensus in #10
|
Thanks @mslw for the review I merged your suggestions. |
These are largely taken from `datalad-next` and reflect the practice for that project for the past months. Co-authored-by: Michał Szczepanik <[email protected]>
|
Code Climate has analyzed commit fbc1f13 and detected 0 issues on this pull request. View more on Code Climate. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
These are largely taken from
datalad-nextand reflect the practice for that project for the past months.