sympy / sympy-bot

GitHub bot for SymPy
https://github.com/sympy-bot
Other
22 stars 11 forks source link

Some edits to the comment messaging #25

Closed asmeurer closed 6 years ago

asmeurer commented 6 years ago

Based on feedback from issue #23

@certik @cbm755 what do you think?

Closes #23

asmeurer commented 6 years ago

(Test up at https://github.com/asmeurer/GitHub-Issues-Test/pull/37)

Example bad status:

Hi, I am the SymPy bot (v34). I'm here to help you write a release notes entry. Please read the guide on how to write release notes.

:x: There was an issue with the release notes. Please do not close this pull request; instead edit the description after reading the guide on how to write release notes.

No release notes were found. Please add release notes to the pull request description. See the guide on how to write release notes for more information.

Note: This comment will be updated with the latest check if you edit the pull request. You need to reload the page to see it.

Click here to see the pull request description that was parsed.

Write your release notes below, and the bot will tell you if they are valid.
Once they are valid you can merge the PR and they will be added to the release
notes file at
https://github.com/asmeurer/GitHub-Issues-Test/wiki/Release-Notes-for-1.2.1

EDIT
<!-- BEGIN RELEASE NOTES -->

<!-- END RELEASE NOTES -->

Example good status:

:white_check_mark:

Hi, I am the SymPy bot (v34). I'm here to help you write a release notes entry. Please read the guide on how to write release notes.

No release notes entry will be added for this pull request.

Note: This comment will be updated with the latest check if you edit the pull request. You need to reload the page to see it.

Click here to see the pull request description that was parsed.

Write your release notes below, and the bot will tell you if they are valid.
Once they are valid you can merge the PR and they will be added to the release
notes file at
https://github.com/asmeurer/GitHub-Issues-Test/wiki/Release-Notes-for-1.2.1

EDIT
<!-- BEGIN RELEASE NOTES -->
NO ENTRY
<!-- END RELEASE NOTES -->

asmeurer commented 6 years ago

The bad message for no release notes now links to the guide three times, which seems a bit too much.