From f244616f67916e028b5edc3b2288bf94ac3cacb3 Mon Sep 17 00:00:00 2001 From: "Asterix\\Oliver" <oliver@currawongeng.com> Date: Sat, 14 Jun 2025 11:08:40 +1000 Subject: [PATCH] Add docs --- BUILDING.md | 2 +- CONTRIBUTING.md | 9 +++++++++ README.md | 2 ++ 3 files changed, 12 insertions(+), 1 deletion(-) create mode 100644 CONTRIBUTING.md diff --git a/BUILDING.md b/BUILDING.md index 9e1d3fea..7b14aa47 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -61,4 +61,4 @@ Build iOS release: ``` invoke ios -``` +``` \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..7a3a70f2 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,9 @@ +## Contribution Guide + +### Formatting Code + +Before submitting code, please ensure that it is properly formatted. You can use the following command to format your code: + +```bash +invoke format +``` \ No newline at end of file diff --git a/README.md b/README.md index c422c6ca..5dbd39e0 100644 --- a/README.md +++ b/README.md @@ -32,3 +32,5 @@ User documentation for the InvenTree mobile app can be found [within the InvenTr ## Developer Documentation Refer to the [build instructions](BUILDING.md) for information on how to build the app from source. + +Refer to the [contribution guidelines](CONTRIBUTING.md) for information on how to contribute to the project.