Missing word and adds PR template (#155)

* docs: adds PR template

* docs: removing sqlfile from wordlist

* update PR template

* fix: removed additional keywords

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,12 @@
+Closes #<issue_number>
+
+### Changes description
+
+*Clearly and concisely describe what's in this pull request. Include screenshots, if necessary.*
+
+### Definition of done
+
+- [ ] *Have you read the [Contributing Guidelines](https://github.com/Appsilon/shiny.telemetry/blob/main/CONTRIBUTING.md)?*
+- [ ] `NEWS.md` file has been updated
+- [ ] Development version has been bumped (`x.y.z.90XX`)
+- [ ] Issue has been linked with this PR _(via [Closing keywords](https://docs.github.com/articles/closing-issues-using-keywords) or right sidebar under `Development`)_

R/data-storage-log-file.R

@@ -1,7 +1,7 @@
-#' Data storage class for JSON Log File
+#' Data storage class for `JSON` Log File
 #'
 #' @description
-#' Implementation of the [`DataStorage`] R6 class to a JSON log file backend using a unified
+#' Implementation of the [`DataStorage`] R6 class to a `JSON` log file backend using a unified
 #' API for read/write operations
 #'
 #' @export
@@ -32,7 +32,7 @@ DataStorageLogFile <- R6::R6Class( # nolint object_name_linter
 
     #' @description
     #' Initialize the data storage class
-    #' @param log_file_path string with path to JSON log file user actions
+    #' @param log_file_path string with path to `JSON` log file user actions
 
     initialize = function(log_file_path) {
       logger::log_debug(

R/telemetry.R

@@ -394,8 +394,8 @@ Telemetry <- R6::R6Class( # nolint object_name_linter
     #' @param track_value flag that indicates if the basic telemetry should
     #' track the value of the input that are changing. `FALSE` by default.
     #' @param matching_values An object specified possible values to register.
-    #' @param input_type 'text' to registered bare input value, 'json' to parse
-    #' value from JSON format.
+    #' @param input_type `"text"` to registered bare input value, `"json"` to parse
+    #' value from `JSON` format.
     #' @param session `ShinySession` object or NULL to identify the current
     #' Shiny session.
     #'

README.md

@@ -49,7 +49,7 @@ telemetry <- Telemetry$new() # 1. Initialize telemetry with default options
 
 shinyApp(
   ui = fluidPage(
-    use_telemetry(), # 2. Add necessary Javascript to Shiny
+    use_telemetry(), # 2. Add necessary javascript to Shiny
     numericInput("n", "n", 1),
     plotOutput('plot')
   ),
@@ -91,7 +91,7 @@ that can range from local filesystem storage to a remote Plumber REST API instan
 
 * Local file:
   * SQLite using `DataStorageSQLite` class
-  * Logfile using `DataStorageLogFile` class
+  * Plain text file using `DataStorageLogFile` class
 * Remote SQL database:
   * MariaDB using `DataStorageMariaDB` class
   * PostgreSQL using `DataStoragePostgreSQL` class

inst/WORDLIST

@@ -1,8 +1,6 @@
 Appsilon
 CMD
-JSON
 Javascript
-Logfile
 RStudio
 Rhinoverse
 UI
@@ -12,5 +10,3 @@ cloneable
 customizable
 filesystem
 hostname
-json
-sqlfile