Skip to content

Commit 687ed8b

Browse files
authored
Add more details on the bot to the README (#3)
* Update README.md * Update README.md
1 parent 94ac1a9 commit 687ed8b

File tree

1 file changed

+32
-2
lines changed

1 file changed

+32
-2
lines changed

README.md

Lines changed: 32 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,42 @@
22

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

7-
the content below is for contributing to the bot.
87

8+
9+
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.
10+
11+
<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">
12+
13+
<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">
14+
15+
16+
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.
17+
18+
<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">
19+
20+
<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">
21+
22+
<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">
23+
24+
<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">
25+
26+
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.
27+
28+
```markdown
29+
---
30+
'@changesets/cli': major
31+
'@changesets/read': minor
32+
---
33+
34+
A very helpful description of the changes
35+
```
936
---
1037

38+
The information below is for contributing to the bot.
39+
40+
1141
## Setup
1242

1343
```sh

0 commit comments

Comments
 (0)