Skip to content

Commit

Permalink
Add more details on the bot to the README (#3)
Browse files Browse the repository at this point in the history
* Update README.md

* Update README.md
  • Loading branch information
emmatown authored Oct 4, 2019
1 parent 94ac1a9 commit 687ed8b
Showing 1 changed file with 32 additions and 2 deletions.
34 changes: 32 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,42 @@

> A GitHub App built with [Probot](https://github.com/probot/probot) that Bot to detect [changesets](https://github.com/atlassian/changesets) in PRs
## Please see https://github.com/apps/changeset-bot for details
## Install the bot at https://github.com/apps/changeset-bot

the content below is for contributing to the bot.


This bot will comment on PRs saying that either a user might need to add a changeset(note that PRs changing things like documentation generally don't need a changeset)or say that the PR is good and already has a changeset.

<img width="1552" alt="screenshot of changeset bot message from https://github.com/mitchellhamilton/manypkg/pull/18 before a changeset was added" src="https://user-images.githubusercontent.com/11481355/66183943-dc418680-e6bd-11e9-998d-e43f90a974bd.png">

<img width="1552" alt="screenshot of the changeset bot message from https://github.com/mitchellhamilton/manypkg/pull/18 showing the changeset good to go message" src="https://user-images.githubusercontent.com/11481355/66184229-cf716280-e6be-11e9-950e-0f64a31dbf15.png">


Sometimes, a contributor won't add a changeset to a PR but you might want to merge in the PR without having to wait on them to add it. To address this, this bot adds a link with the filename pre-filled to add a changeset so all you have to do is write the changeset and click commit.

<img width="1552" alt="screenshot of the changeset bot message from https://github.com/mitchellhamilton/manypkg/pull/18 focused on the create a changeset link" src="https://user-images.githubusercontent.com/11481355/66184052-3a6e6980-e6be-11e9-8e62-8fd9d49af587.png">

<img width="1552" alt="screenshot of creating a changeset directly on GitHub" src="https://user-images.githubusercontent.com/11481355/66184086-5bcf5580-e6be-11e9-8227-c1ed6d96b5d2.png">

<img width="1552" alt="screenshot of the GitHub file creation page focusing on the commit button" src="https://user-images.githubusercontent.com/11481355/66184181-a94bc280-e6be-11e9-85fc-32edcd5b05ce.png">

<img width="1552" alt="screenshot of the changeset bot message from https://github.com/mitchellhamilton/manypkg/pull/18 showing the changeset good to go message" src="https://user-images.githubusercontent.com/11481355/66184229-cf716280-e6be-11e9-950e-0f64a31dbf15.png">

When writing the changeset, it should look something like this with the packages that are being released in the YAML front matter with associated semver bump types and the summary of the changes in markdown.

```markdown
---
'@changesets/cli': major
'@changesets/read': minor
---

A very helpful description of the changes
```
---

The information below is for contributing to the bot.


## Setup

```sh
Expand Down

1 comment on commit 687ed8b

@vercel
Copy link

@vercel vercel bot commented on 687ed8b Oct 4, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.