Developer docs: contribution basics
Open
@gregorysprenger is already working on this.
Since Mar 27, 2023.
documentation
hackathon
- Dominant language
- MDX
- Stars
- 98
- Forks
- 298
- Avg merge
- 14h 38m
- Merged PRs (30d)
- 38
Description
Is your feature request related to a problem? Please describe.
There were some confusions from where to checkout from, like master and dev. For new people this might be difficult, and they only realise they should raise PR against dev once they reach the PR checklist
A scenario from today in slack - https://nfcore.slack.com/archives/C01QPMKBYNR/p1616421940076700
Describe the solution you'd like
Some small workflow how to start -
For new a existing repo to make changes -
- make a fork of your own
- dev is the latest branch, so always checkout from here
- edit and commit
- PR against dev branch in main repo
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.