Skip to content

Latest commit

 

History

History
52 lines (30 loc) · 1.79 KB

CONTRIBUTING.md

File metadata and controls

52 lines (30 loc) · 1.79 KB

Contributing

That would be awesome if you want to contribute something to BitBLAS!

Reporting Bugs

If you run into any weird behavior while using BitBLAS, feel free to open a new issue in this repository! Please run a search before opening a new issue, to make sure that someone else hasn't already reported or solved the bug you've found.

Any issue you open must include:

  • Code snippet that reproduces the bug with a minimal setup.
  • A clear explanation of what the issue is.

Asking Questions

Please ask questions in issues.

Submitting Pull Requests

All pull requests are super welcomed and greatly appreciated! Issues in need of a solution are marked with a ♥ help label if you're looking for somewhere to start.

Please run ./format.sh before submitting a pull request to make sure that your code is formatted correctly.

Please include tests and docs with every pull request!

Repository Setup

To run the build, you need to have the BitBLAS repository cloned to your computer. After that, you need to cd into the directory where you cloned it, and install the dependencies with python:

python setup.py install

Running Tests

To run the tests, start by building the project as described in the Repository Setup section.

Then you can rerun the tests with:

python -m pytest testing