renovatebot/renovate

Add a badge/shield to the README as part of the initial PR

Open

#11,436 opened on Aug 26, 2021

View on GitHubContributor guide
 (3 comments) (0 reactions) (0 assignees)TypeScript (1,916 forks)batch import
core:onboardinghelp wantedpriority-4-low

Repository metrics

Stars
 (14,066 stars)
PR merge metrics
 (PR metrics pending)

Description

What would you like Renovate to be able to do?

As part of the initial Merge/Pull Request that Renovate creates, it’d be nice if the README was updated with a badge/shield as an indicator that Renovate is (going to be) enabled for that repository.

Example shield:

[![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg?logo=renovatebot)](https://renovatebot.com/)

If you have any ideas on how this should be implemented, please tell us here.

The code for the badge/shield could be added immediately after the header in the README.

Is this a feature you are interested in implementing yourself?

No

Contributor guide

Research direction
Locate the code that generates the initial pull request description and find where to insert the badge markdown. Check if there is a configuration option to enable/disable this feature.
Tech stack
typescript
Domain
documentationdeveloper experience
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85