Skip to content

Commit 238c4cb

Browse files
authored
Create CONTRIBUTING.md
1 parent cc5e076 commit 238c4cb

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

CONTRIBUTING.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Contribution Guidelines
2+
3+
Please feel encouraged to make a pull request (PR) to correct or clarify code.
4+
5+
Some rough guidelines for making a PR:
6+
7+
* Bug fixes and operating-system specific fixes are very welcome.
8+
* When making a PR please make sure both the PR and the code is commented clearly for other book readers.
9+
* Do not introduce code copy-pasted from elsewhere as there are licencing and copyright issues with this.
10+
* Please do not submit CMakeLists.txt or build scripts for the entire book or for individual chapters. There is a specific chapter dedicated to introducing build systems.
11+
* Please do not submit project or solution files for a particular IDE.
12+
* Code in examples is copy-pasted from the book. If the PR needs to modify these please add a comment to those lines indicating why the change was important.
13+
* Code style and language version changes are discouraged unless they fix a bug.
14+
* If you are happy to be added to a contributors list then please add your name, as you would like it to appear, as a bullet at the bottom of this file.

0 commit comments

Comments
 (0)