Skip to content

Latest commit

 

History

History
55 lines (43 loc) · 2.6 KB

CONTRIBUTING.md

File metadata and controls

55 lines (43 loc) · 2.6 KB
Raw

Contributing

Thanks for contributing to the project! Before submitting a pull request, please read through the following guidelines.

Testing

Github Actions

The repository currently has two Github Actions workflows in place. The first tests dependency installation and linting, while the second tests that the bot can log in. However, the latter is not run on pull requests, because it fails without the access token. Pull requests that do not pass the first test will not be accepted, as they break the bot.

Manual Testing

Before submitting a pull request, do a test run of Alice is Missing as follows:

  • Start the bot (for instructions on how to do so, see the documentation here).
  • Add two more accounts to the server (in order for the bot to see enough players) and assign yourself and the others character roles. You can also do this with only one extra account by assigning a role to the bot. Make sure that you have the Charlie role and that your nickname is set to "Charlie Barnes".
  • Run through a game by calling !init, !setup_clues, and !start. Manually assigning the 10 minute card is optional, as the bot will auto assign it to Charlie if the command is never called. You can leave this to run in the background, as it will take the full 90 minutes.
  • Copy and paste the starting message for Charlie Barnes into the group chat channel, then go back to the bot channel and call !pdf. If this runs without errors, open the exported PDF file and make sure it matches the game.

If you've reached this point and nothing looks amiss, you're done! Submit the pull request, and thanks again for the help.

You can also use the debug commands to run the bot at a higher speed to avoid having to wait the full 90 minutes for each run to complete. However this may not reflect the bot's behavior when run normally, so please test it once at normal speed before submitting a pull request. Documentation on the bot's debug commands can be found here.

Changes to Localization

To test changes to localization files, run the bot using the matching language key and then run !server_setup to generate the appropriate channels.

If adding a new localization file, please add the English names for commands as an alias when changing the command names, as this both makes testing the bot easier and allows users to follow the commands as written in the documentation (which is currently all written in English) even when running the bot in another language.