Update git usage page with advice on pull requests etc
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- git
- Domain
- documentation
Research direction
Start with the GitUsage page and compare it with the Contributing page and relevant GitHub resources. Confirm the intended scope in the comment thread, then make the guidance shorter while retaining Biopython-specific development-model advice, including pull-request rebasing and fast-forward merging.
Written by the indexing model from the issue text.
Description
We could update http://biopython.org/wiki/GitUsage to be much shorter (refer to more external resources at GitHub or elsewhere rather than duplicate things) (update: perhaps not, see below), and concentrate on for Biopython specific topics like our development model (and link to http://biopython.org/wiki/Contributing or a new page specifically on coding styles, testing, etc).
For example, since we've tried to continue a single-branch model, most of our pull requests have been rebased and fast-forward merged (giving a linear history). To facilitate this, it can be helpful for the contributor to sometimes rebase and update their pull request (git fetch origin then ``git rebase origin/masterandgit push your_fork your_branch --force`), although often the person merging the PR will do this at the command line.
- Dominant language
- CSS
- Stars
- 167
- Forks
- 379
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
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.
More from biopython/biopython.github.io
-
Difficulty 2/5 1-3 hours Newbie friendliness 48/100
biopython/biopython.github.io#117 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 35/100
biopython/biopython.github.io#98 · 3 comments ·
-
help wanted
Difficulty 3/5 1-2 days Newbie friendliness 42/100
biopython/biopython.github.io#85 · 2 comments ·
-
Include build instructions in README so contributors can (easily) get a local Jekyll setup going Openhelp wanted
Difficulty 2/5 Half a day Newbie friendliness 42/100
biopython/biopython.github.io#79 · 6 comments ·
-
help wanted
Difficulty 2/5 Half a day Newbie friendliness 48/100
biopython/biopython.github.io#62 · 6 comments ·
All issues in biopython/biopython.github.io
Similar issues
-
triage
Difficulty 1/5 1-3 hours Newbie friendliness 88/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
feature pydanty:is-working
Difficulty 1/5 Under an hour Newbie friendliness 88/100
pydantic/pydantic-ai#8647 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
:watch: Not Triaged dotnet-fsharp/svc
Difficulty 1/5 Under an hour Newbie friendliness 90/100