Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Bot output conventions #490

Merged
merged 1 commit into from
Aug 2, 2018
Merged

Bot output conventions #490

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
11 changes: 11 additions & 0 deletions docs/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,3 +29,14 @@ Always write a clear log message for your commits. One-line messages are fine fo
* We prefer `elseif` to `else if`
* We use `echo` and `exit` for normal code, and `print` and `die` for debug code that is intended to be removed later
* All code must be both valid PHP 5.5.9 and valid PHP 7.0

## Bot output conventions
The bot reports its activity to users using:
* A new line beginning with an asterisk `*_` to announce that a new item is being analysed
* A new line beginning with a space and a hyphen `_-_` to announce that it is undertaking an expansion activity
* A new line beginning with three spaces and a symbol `___X_` to denote that it is changing the value of a parameter:
* `+` denotes a newly added parameter
* `-` denotes the removal of a parameter
* `~` denotes that the name or value of an existing parameter is being modified
* `!` is used to denote an outcome that may require review by the user or bot maintainer