Skip to content

Commit c861667

Browse files
authored
Create CONTRIBUTING.md
1 parent 0f957be commit c861667

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

CONTRIBUTING.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Contributing
2+
3+
Thank you for investing your time in contributing to this project! ✨.
4+
5+
## Make Changes
6+
7+
When you're finished with the changes, create a pull request, also known as a PR.
8+
9+
* Please helps reviewers understand the purpose of your pull request.
10+
* Don't forget to link PR to issue if you are solving one.
11+
* If you run into any merge issues, please resolve merge conflicts and other issues.
12+
13+
## Development
14+
15+
### Build
16+
17+
Install `clang-tools` from source code
18+
19+
```bash
20+
git clone git@github.com:shenxianpeng/clang-tools-pip.git
21+
# Need root permission
22+
sudo python3 setup.py install
23+
# Install clang-tools version 13
24+
sudo python3 main.py --install true --version 13
25+
```
26+
27+
### Test
28+
29+
```bash
30+
cd tests
31+
# run test
32+
pytest
33+
# run test with code covarege
34+
coverage run -m pytest
35+
```

0 commit comments

Comments
 (0)