Add config template #348
Merged
Add config template #348
Conversation
This file contains hidden or 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
Zabuzard
added
documentation
Zabuzard
requested review from
I-Al-Istannen,
marko-radosavljevic,
illuminator3 and
Tais993
|
Kudos, SonarCloud Quality Gate passed!
|
Tais993
approved these changes
Jan 20, 2022
Heatmanofurioso
approved these changes
Jan 20, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Overview
Closes #234. This adds a
config.json.templatefile, containing reasonable default values and some placeholders for the configuration file of the bot.This is a solution to the problem of maintaining the
config.jsonthat we all have to use in a transparent way without git-tracking the realconfig.jsonand accidentally commiting our real bot tokens when doing changes.That approach seems to be the most idiomatic way currently used (see for example https://stackoverflow.com/questions/9794931/keep-file-in-a-git-repo-but-dont-track-changes).
This also gets rid of the problems we had with forgetting to maintain the default config in our Wiki (we can now simply refer to this template instead) and it eases the flow for people when rebasing
developwhen it introduces changes to the config.