ml-opensource / ml-opensource/flutter-template

Update pull request template to be more meaningful

Open
#59 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Dart
Stars
37
Forks
23
PR merge metrics
No merged PRs in 30d

Description

Why?

The current template doesn't bring much value. It results in us skipping the checkmarks and no one reading the PR description, although it may contain some notes about the PR and the ticket.

What to do?

To make the PR template more contextualized. We can put there the implementation details, steps to test and so on.

With this, we will make the life easier for the reviewers as they will be able to jump into the context of the task from the PR description.

I would also suggest to upload a quick video demo of what has been changed/implemented.

Examples with custom templates

Contributor guide

No contributing guide indexed for this repository

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 by reviewing the current pull request template and compare it with the linked Gems and Onro templates. Done means the template prompts contributors for implementation details, testing steps, and a quick video demo so reviewers can understand the change.

Written by the indexing model from the issue text.

Assessment

Tech stack
dart, flutter
Domain
developer-experience, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.