Update README #42
Update README #42
Conversation
Provide some more guidance around finding Slack IDs and tokens, and running the included docker-based postgres server.
|
Good idea to give some directions where to find stuff. However, I think the big screenshots are a bit over the top. Maybe provide a link + directions (slack->settings->...) and smaller screenshot of the required field only. I can also take a look at the contributor description and provide some more details how to setup stuff. |
|
That makes sense. Here's another take with less detail. I deleted the screenshots since they're only useful to show some surrounding context. For highlighting a specific field text works just as well or better. If you're considering updates to the contributor description, the changes here are probably redundant. In that case maybe it makes more sense to close this and keep the readme simple. Your call of course - either way seems reasonable. |
|
Thanks @ajkerrigan, @pogross merge this in or are you move some of this into setup instructions? |
|
Can be merged for now. I will take another look later in a separate PR. Maybe its better to use the docker infos to contributor section as it has no direct relation to the config file description. |
* bump version for pypi package generation to match git tag * Fix version (#40) * add runtime file for heroku * allow any 3.7 sub version * breaks heroku deploy, poetry build pack makes this file * dummy commit * version bump * Update README (#42) * Add some Slack and Docker detail to the README Provide some more guidance around finding Slack IDs and tokens, and running the included docker-based postgres server. * Remove readme detail * Allow `topchannels` command in private messages (#41) Let people review the top channel list in the peace and comfort of their own DMs :) * add error handling for env vars; run pre-commit (#43) * fix python version and enable test for PRs * add a fake KARMABOT_DATABASE_URL to the nox env (#48) * Improve joke command (#45) * add error handling for env vars; run pre-commit * improve joke command (issue #37): get list of categories from pyjokes module and find closest match with difflib * refactor logic of category match into helper function with own tests * version bump * Update versions of python, nox, poetry Co-authored-by: AJ Kerrigan <[email protected]> Co-authored-by: Michael Aydinbas <[email protected]> Co-authored-by: Patrick-Oliver Groß <[email protected]>
These updates are based on some Slack discussion. There may be other/better ways to convey this information to new contributors, so other suggestions are welcome. This is just one idea :).