CuPBoP/CONTRIBUTING.md

35 lines
866 B
Markdown
Raw Normal View History

2022-05-07 04:08:28 +08:00
# Contributing to CuPBoP
2022-05-07 04:08:28 +08:00
Thank you for your interest in contributing to CuPBoP!
We appreciate all contributions, including but not limited to:
- Add documentation
- Add new features and components
- Fix bugs
## How to contribute?
0. (Optional) Open an issue and discuss your idea before start
2022-05-07 04:08:28 +08:00
1. Fork the latest version CuPBoP
2. Commit to the forked repo
2022-05-07 04:08:28 +08:00
3. Create a Pull Request to CuPBoP main branch
## Code style
We follow the Clang format in this repo.
To make sure your contribution is following the correct style,
we highly recommend you to install [pre-commit](https://pre-commit.com/) before development.
```bash
2022-05-04 20:59:38 +08:00
# Python environment is required
pip install pre-commit
```
Then, from the repository folder, execute the following instruction:
```bash
2022-05-04 20:59:38 +08:00
pre-commit install
```
With pre-commit plugin, each local commit will be automatically checked.