Merge pull request #222 from antonioribeiro/add-linting

Add PHPUnit tests to the linting workflow
antonioribeiro · Oct 20, 2024 · 6cf238b · 6cf238b
2 parents eb71876 + 7a140a9
commit 6cf238b
Show file tree

Hide file tree

Showing 3 changed files with 337 additions and 182 deletions.
diff --git a/README.md b/README.md
@@ -409,6 +409,17 @@ Google2FA is licensed under the MIT License - see the [LICENSE](LICENSE.md) file
 
 Pull requests and issues are more than welcome.
 
+### Contribution setup
+
+If you want to contribute, make sure code is checked, tested, linted and formatted before pushing it.  
+
+Please install NPM packages to setup a husky pre-commit hook that will help you with that:
+
+```bash
+npm install
+npm run prepare
+```
+
 ## Sponsorships
 
 ### Direct