Create CONTRIBUTING.md

vincentarelbundock · Oct 18, 2024 · e294aac · e294aac
1 parent 2853f95
commit e294aac
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,9 @@
+# Coding conventions
+Pydoc style followed: Numpydoc, see [link](https://numpydoc.readthedocs.io/en/latest/format.html)
+
+# FAQ
+## How to use Makefile
+### Windows
+1. Install make for Windows https://gnuwin32.sourceforge.net/packages/make.htm.
+2. Add it to your path variable.
+3. Then you can use scripts specified in the Makefile. e.g. `make test`