Merge branch 'add-contributing-docs'

mullvad · Aug 30, 2024 · d133394 · d133394
2 parents fce72ad + e0d4210
commit d133394
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,17 @@
+# Notes for developers
+
+Please read this before hacking on/contributing to `unicop`.
+
+
+## Run tests
+
+The directory [`example-files/`](example-files/) contain files for various programming languages and with various
+"bad" unicode in them. These can be used to test out `unicop` while developing.
+
+Automatic tests also run against these to verify the output of `unicop` stays consistent, and the correct
+issues are raised.
+
+## Git commit style
+
+Please follow the guidelines at https://cbea.ms/git-commit/ for git commit message style. There is a CI
+job that will enforce this.
diff --git a/README.md b/README.md
@@ -43,6 +43,11 @@ $ unicop example-files/homoglyph.js example-files/invisible.js
 
 ```
 
+## Contributing to unicop
+
+Please see the [contribution](CONTRIBUTING.md) documentation for details on how to understand, build and test
+this program, as well as submitting changes.
+
 ## Todo
 
 Things left to implement to make this usable