Browse Source

Improve and update lint documentation

Gabriel Horner 3 years ago
parent
commit
f39f26c8d3
2 changed files with 15 additions and 6 deletions
  1. 7 4
      docs/contributing-to-translations.md
  2. 8 2
      docs/dev-practices.md

+ 7 - 4
docs/contributing-to-translations.md

@@ -67,9 +67,9 @@ you're hoping to have this list drop to zero.
 
 Almost all translations are pretty quick. The only exceptions to this are the keys `:tutorial/text` and `:tutorial/dummy-notes`. These reference files that are part of the onboarding tutorial. Most languages don't have this translated. If you are willing to do this, we would be happy to have this translated.
 
-## Fix Mistakes
+## Fix Untranslated
 
-There is a lot to translate and sometimes we make mistakes. For example, we may leave a string untranslated. To see what translation keys are still left in English:
+There is a lot to translate and sometimes we forget to translate a string. To see what translation keys are still left in English:
 
 ```
 $ bb lang:duplicates
@@ -82,8 +82,11 @@ Keys with duplicate values found:
 |                               :no |               No |
 ```
 
-Sometimes, we typo the translation key. If that happens, the github CI job will
-detect this error and helpfully show you what was typoed.
+## Fix Mistakes
+
+Sometimes, we typo the translation key. If that happens, the github CI step of
+`bb lang:invalid-translations` will detect this error and helpfully show you
+what was typoed.
 
 ## Add a Language
 

+ 8 - 2
docs/dev-practices.md

@@ -5,7 +5,8 @@ This page describes development practices for this codebase.
 ## Linting
 
 Most of our linters require babashka. Before running them, please install
-https://github.com/babashka/babashka#installation.
+https://github.com/babashka/babashka#installation. To invoke all the linters in
+this section, run `bb dev:lint`.
 
 ### Clojure code
 
@@ -49,7 +50,7 @@ and understand them. To run this linter:
 bb lint:large-vars
 ```
 
-To configure the linter, see its `config` var.
+To configure the linter, see the `[:tasks/config :large-vars]` path of bb.edn.
 
 ### Datalog linting
 
@@ -60,6 +61,11 @@ queries and rules. Our queries are linted through clj-kondo and
 [datalog-parser](https://github.com/lambdaforge/datalog-parser). clj-kondo will
 error if it detects an invalid query.
 
+### Invalid translations
+
+Our translations can be configured incorrectly. We can catch some of these
+mistakes [as noted here](./contributing-to-translations.md#fix-mistakes).
+
 ## Testing
 
 We have unit and end to end tests.