From ca35169ec7470790b48630c5442e1e70702d9f81 Mon Sep 17 00:00:00 2001 From: Joshua Aresty Date: Sat, 6 Jul 2024 11:53:59 -0700 Subject: [PATCH] Adds some configuration recommendations to contributing read me --- CONTRIBUTING.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c5ddf51543..0b49c70202 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,3 +11,9 @@ Each of the principles is numbered for easy referencing. The body is formatted a - P03 - Use the `app.bundle` matcher for apps on OSX. This is the least ambiguous way of referring to a particular program. - P04 - Use both `app.name` and `app.exe` matchers for apps on Windows. That is the context should OR together one matcher of each type. Apparently the [MUICache](https://www.magnetforensics.com/blog/forensic-analysis-of-muicache-files-in-windows/) can break, perhaps making one of these matchers stop working. + +# Configuration + +Sometimes it is useful to allow for users to specify the configuration settings that they would like. We often use the `settings.talon` file to do this. + +Since some users prefer to set settings using a file outside of this repository, it is easier for those users if we do not hard code the settings values into the `settings.talon` file. Instead, it is helpful to provide an example setting that is commented out in that file and set a default value in Python code in case the setting is not present in the `settings.talon` file.