Skip to content

Commit 4d8a9af

Browse files
committedDec 2, 2017
Add CONTRIBUTING.md
1 parent 9a08551 commit 4d8a9af

File tree

2 files changed

+50
-0
lines changed

2 files changed

+50
-0
lines changed
 

‎CONTRIBUTING.md

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
Contributions to the library are gladly accepted.
2+
3+
The main development happens in https://github.com/p12tic/libsimdpp repository.
4+
5+
If you don't have time to submit a bug fix, please open an issue report on
6+
GitHub so at least the problem is known. The same applies to improvements -
7+
don't hesitate to open feature request so that the design of new APIs could
8+
take your use case into account.
9+
10+
Documentation
11+
-------------
12+
13+
The documentation is written on a MediaWiki instance which is currently private.
14+
If you find a problem in the documentation, please open an issue with a link to
15+
the page in question.
16+
17+
Code changes
18+
------------
19+
20+
Please test your code changes by running the following:
21+
22+
```
23+
mkdir build
24+
cd build
25+
cmake ..
26+
27+
# on Linux / macOS
28+
make check -j8
29+
30+
# on Windows
31+
cmake --build . --target check
32+
```
33+
34+
Please use the `dev` branch as a target for pull requests. The reason for this
35+
is that the public continuous integration services used by the library cover
36+
only SSE2-AVX2 instruction sets. The rest are periodically tested on a private
37+
test farm. Due to the number of tested compilers and library configurations
38+
this testing is usually done only on each merge from the `dev` branch to
39+
the `master` branch.
40+
41+
Code style
42+
----------
43+
44+
C-style pointer casts are discouraged, use reinterpret_cast for that. For
45+
non-pointer types C-style casts are preferred over static_cast or constructor.

‎README.md

+5
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,11 @@ simdpp/detail/workarounds.h for more details.
101101

102102
- MSA is not supported on GCC 6.x and older.
103103

104+
Contributing
105+
------------
106+
107+
Contributions are welcome. Please see CONTRIBUTING.md for more information.
108+
104109
License
105110
-------
106111

0 commit comments

Comments
 (0)
Please sign in to comment.