This repository has been archived by the owner on Sep 6, 2021. It is now read-only.
Updated gitignore to ignore ./local-config.yml #19
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
SizableShrimp
suggested changes
Feb 7, 2020
| @@ -5,6 +5,7 @@ The intention of this bot is to make moderation easier and provide useful comman | |||
|
|
|||
| ## Running the bot | |||
| 1. Copy `src/main/resources/sample-config.yml` and use it to structure your bot config. | |||
| We recommend to copy the file to ./local-config.yml since this is added to the .gitignore file so that your token is not pushed to the repository. | |||
There was a problem hiding this comment.
Explaining things with simplicity but also specifics is important for our README so that new programmers can jump in and not be intimidated by any verbiage. Maybe something like
We recommend to copy the file as
local-config.ymlto the project base directory so that your bot token is not pushed to the repository.
would be more beneficial as it keeps it simple but also tries to be detailed in instruction. Renaming the filename to just config.yml may also be something to keep in mind. Regardless, thank you for taking the time to make a pull request!
SizableShrimp
added
documentation
This pull request was closed.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
See #18 for details