riscv-software-src / riscv-software-src/opensbi

Suggestion: Add a pull request template (to discourage PRs)

Open
#395 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C
Stars
1.5k
Forks
712
PR merge metrics
No merged PRs in 30d

Description

Since GitHub apparently does not want to give people the ability to disable the pull request tab altogether, the next best option might be to add a pull request template that pre-fills the PR description with a friendly note that redirects people to the mailing list.

This would avoid the current scenario where some people spend time preparing a pull request just to have it closed by a bot, because they would be greeted with the content of that bot message as soon as they press the "New pull request" button, i.e. before they create it.

See https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with GitHub's pull request template documentation linked in the issue and inspect how this repository stores contribution templates. Add a template that directs prospective contributors to the mailing list before they submit a pull request; done means the template appears when creating a new pull request and conveys the intended bot message.

Written by the indexing model from the issue text.

Assessment

Tech stack
github
Domain
developer-experience
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.