Skip to content

Latest commit

 

History

History
68 lines (43 loc) · 2.71 KB

CONTRIBUTING.md

File metadata and controls

68 lines (43 loc) · 2.71 KB
Raw

Contributions

Contributions are welcome, encouraged, and appreciated!

If you encounter any bugs while using the project, or believe there's a feature that would prove useful, feel free to submit a new issue.

All contributions, suggestions, and feedback you submitted are accepted under the project's license.

Submitting an Issue

Issues should be used to report problems with the package or any of its dependencies, request a new feature, or to discuss potential changes before a PR is created.

When reporting bugs, please provide a minimal reproducible example, the version of the package, and the environment (e.g., Python version).

If you find an existing Issue that addresses the problem you're having, please add your own reproducible example to the existing issue rather than creating a new one.

Submitting a Pull Request

PRs are always welcome and can be a quick way to get your fix or improvement merged. In general, PRs should:

  • Only fix/add the functionality in question.
  • Address a single concern in the fewest number of changes possible.
  • Include updated documentation.

For changes that address core functionality or would require breaking changes (e.g., a major release), it's generally best to first open an Issue to discuss your proposed changes.

In general, we follow the "fork-and-pull" Git workflow

  • Fork the repository to your own GitHub account
  • Clone the project to your machine
  • Create a branch locally with a succinct but descriptive name
  • Commit changes to the branch
  • Following any formatting and testing guidelines specific to this repo
  • Push changes to your fork
  • Open a PR in our repository

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:

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

Testing Your Changes

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

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:

brew install openblas
brew install lapack
export SYSTEM_VERSION_COMPAT=1

Then try rebuilding.