dependabot / dependabot/dependabot-core

feature request: minimal PR description option/formatting

Open
#1,986 8 comments 18 reactions 0 assignees View on GitHub
core 🍏 F: configuration-file F: pull-requests service 💁 T: feature-request
Dominant language
Ruby
Stars
5.8k
Forks
1.5k
Avg merge
2d 18h
Merged PRs (30d)
149

Description

Right now, Dependabot fills the PR description with HTML. This provides a very pretty PR in the Github UI, but plays poorly with git workflows that use the PR description when that PR is merged. We end up with commit messages that look like this:

![Screen Shot 2020-04-23 at 11 38 41 AM](https://user-images.githubusercontent.com/773524/80084508-408f3f00-8557-11ea-8947-30461e2f75f6.png)

This is from https://github.com/tendermint/tendermint/commit/ad9003d448abdb1aeb105025fceb683198ffac7b. If you scroll down, you can even see that the commit message has Dependabot usage instructions in there!

**It would be awesome to have a formatting option to use plaintext or even markdown for the PR body, and even more awesome to have a "minimal" option that didn't include Dependabot instructions and other superfluous stuff.** This seems similar to https://github.com/dependabot/feedback/issues/287, but not exactly.

Thanks y'all! My team loves Dependabot, and we'd love to see it get even better!

Contributor guide

Open the contributing guide

Research direction

The issue names no files, tests, or entry points. Start by locating the Dependabot code that assembles GitHub PR descriptions, then determine how formatting and minimal-content options should be represented and tested; done means users can choose plaintext or Markdown and omit the extra instructions and other superfluous content.

Written by the indexing model from the issue text.

Assessment

Tech stack
github, ruby
Domain
developer-experience
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.