chore: Add CONTRIBUTE.md

Bravos-Power · Apr 18, 2024 · cdef46b · cdef46b
1 parent e788da4
commit cdef46b
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/CONTRIBUTE.md b/CONTRIBUTE.md
@@ -0,0 +1,15 @@
+# How to contribute
+
+Contributions are welcome! Simply submit a pull request on GitHub with your changes and they will be reviewed. Or [open an issue](https://github.com/Bravos-Power/pyoframe/issues/new) to start a discussion before working on changes.
+
+## How to setup a development environment
+
+1. Install the dependencies: `pip install --editable .[dev,docs]`
+
+2. Run `pytest` to make sure everything is working. If not, [open an issue](https://github.com/Bravos-Power/pyoframe/issues/new)!
+
+### Some helpful commands
+
+- `pytest`: Runs all the tests.
+- `mkdocs serve`: Generates the documentation locally. Navigate to [`http://127.0.0.1:8000/pyoframe/`](http://127.0.0.1:8000/pyoframe/) to check it out.
+
diff --git a/README.md b/README.md
@@ -6,6 +6,10 @@
 
 A library to rapidly formulate large and sparse optimization models using Pandas or Polars dataframes.
 
+## Contribute
+
+Contributions are welcome! See [`CONTRIBUTE.md`](./CONTRIBUTE.md).
+
 ## Acknowledgments
 
 Martin Staadecker first created this library while working for [Bravos Power](https://www.bravospower.com/) The library takes inspiration from Linopy and Pyomo, two prior libraries for optimization for which we are thankful.