sanitizers / sanitizers/patchback-github-app
Improve the manual backporting instructions
Open
Nobody has claimed this yet.
enhancement
good first issue
help wanted
- Dominant language
- Python
- Stars
- 14
- Forks
- 10
- Avg merge
- 4m
- Merged PRs (30d)
- 3
Description
- It seems like the markdown formatting is a bit off — the paragraphs probably need to be single-lined.
- The guide does not include details on the PR creation so the inexperienced contributors sometimes forget to switch the PR base branch from main/master/devel/etc to the correct backport target.
- Bonus points for including a link to the specific PR creation page with the base branch pre-selected, if that's possible (it's not possible to choose the incoming branch, though, because it may be coming from a random fork depending on who submits it).
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.
Research direction
Start with the manual backporting instructions referenced in the issue and review their Markdown formatting and PR-creation guidance. Update the paragraphs, explain how to choose the correct backport target as the PR base branch, and include a preselected PR-creation link if GitHub supports it; the guide should cover the workflow without relying on unstated incoming-branch details.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github, markdown
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100