Skip to content

Commit

Permalink
Update contribution info
Browse files Browse the repository at this point in the history
  • Loading branch information
reidjohnson committed Nov 20, 2023
1 parent 556f618 commit 86341cb
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 30 deletions.
30 changes: 0 additions & 30 deletions CONTRIBUTING

This file was deleted.

40 changes: 40 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Contributions

Contributions are welcome, encouraged, and appreciated!

If you encounter any bugs while using `quantile-forest`, or believe there's a feature that would prove useful, feel free to [submit a new issue](https://github.com/zillow/quantile-forest/issues/new/choose).

All contributions, suggestions, and feedback you submitted are accepted under the [project's license](https://github.com/zillow/quantile-forest/blob/main/LICENSE).

## Setting Up Your Environment

To contribute to the `quantile-forest` source code, start by forking and then cloning the repository (i.e. `git clone [email protected]:YourUsername/quantile-forest.git`)

Once inside the repository, to build and install the package, run:

```cmd
python setup.py build_ext --inplace
python setup.py install
```

## Testing Your Changes

To execute unit tests from the `quantile-forest` repository, run:

```cmd
pytest quantile_forest -v
```

## Troubleshooting

If the build fails because SciPy is not installed, ensure OpenBLAS and LAPACK are available and accessible.

On macOS, run:

```cmd
brew install openblas
brew install lapack
export SYSTEM_VERSION_COMPAT=1
```

Then try rebuilding.

0 comments on commit 86341cb

Please sign in to comment.