Skip to content
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

Closed
wants to merge 1 commit into from
Closed

Updated gitignore to ignore ./local-config.yml #19

Show file tree
Hide file tree
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
### Project specific ###
# gitignore local-config in project root so devs do not checkin their discord tokens
/local-config.yml


### Build and IntelliJ ###
target/
.idea/
out/
Expand Down
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.yml to 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!

2. Start the bot with following arguments: `-c path/to/your/config`

## Contributing
Expand Down