add sentry & version numbering info authored by GlitchMasta47's avatar GlitchMasta47
......@@ -25,6 +25,23 @@ my_list = [
```
format.
# version number
The script (for the most part) follows [semver](https://semver.org) (short for semantic versioning) where each part of the version number has a specific meaning. For our script, we use the following format:
```
[season number].[major or medium changes].[minor changes or bug fixes]
^ section 1 ^ section 2 ^ section 3
```
When one of these parts is increased, the ones following it must be set to zero. Section 1 (season number) should be increased by one every time a new season of the stream starts. Section 2 (major or medium changes) should be increased by one every time a major or medium change happens to the script or a command. Section 3 (minor changes or bug fixes) should be increased by one every time a minor change happens to the script or a command, or if a bug is fixed in the script or a command.
"Major or medium changes" are things like adding, removing, or changing important parts of a command (for example, making a new command or changing the arguments of an existing command). "Minor changes or bug fixes" are things like adding or changing features that don't directly affect commands or fixing small to medium size bugs in the script or commands (for example, the recent Unicode bug in the type command falls under this category).
# error logging
The script uses [Sentry](https://sentry.io) to log and keep track of errors throughout each release.
Sentry logging is automatically disabled for non-production environments unless `force_sentry_enabled` is `True` in `config.toml`. For production environments, the `sentry_enabled` setting in `config.toml` will enable or disable Sentry logging.
# requirements
It's pretty simple to understand, you only have to install a few packages, most of them are either file imports or part of the python standard library.
......
......