Skip to content

Commit 9121f9b

Browse files
committed
add contribution guidelines
1 parent dc41642 commit 9121f9b

File tree

2 files changed

+25
-3
lines changed

2 files changed

+25
-3
lines changed

CONTRIBUTING.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Contribution guidelines
2+
3+
Feel free to open an issue with your comments / encountered bugs / requests for features.
4+
5+
In case you want to contribute a PR, please open an issue first with a bit of details about the planned change or comment on an existing issue that you want to work on it.
6+
7+
The repository mostly uses the Google C++ [style guide](https://google.github.io/styleguide/cppguide.html).
8+
9+
## clang-format
10+
11+
Formatting is checked upon submission, please format your files with the included `.clang-format` configuration. Use the provided scripts for your convenience:
12+
13+
```
14+
/misc/scripts/format.ps1
15+
/misc/scripts/format.sh
16+
```
17+
## clang-tidy
18+
19+
Static analysis is checked upon submission, please make sure there are 0 clang-tidy warnings in your code, using the included `.clang-tidy` configutaion. Use the provided scripts for your convenience:
20+
21+
```
22+
/misc/scripts/tidy.ps1
23+
/misc/scripts/tidy.sh
24+
```

README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -84,9 +84,7 @@ Open the "Developer PowerShell for VS 2022" profile in Windows Terminal and run
8484

8585
Contributions are more than welcome, there is a couple of ideas for enhancements in [open issues](https://github.com/krupkat/xpano/issues) which you could take on - if you start working on one of them, please add a comment there.
8686

87-
Feel free to open an issue with your comments / encountered bugs / requests for features.
88-
89-
In case you want to contribute a PR, please open an issue first with a bit of details about the planned change.
87+
Please check the [contribution guidelines](https://github.com/krupkat/xpano/blob/main/CONTRIBUTING.md) for further details regarding formatting and coding style.
9088

9189
## License
9290

0 commit comments

Comments
 (0)