Skip to content

Commit de4aa26

Browse files
committed
update contributing guidelines
1 parent 1072bae commit de4aa26

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

.github/CONTRIBUTING.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,19 +11,20 @@ Our code contriubtion guidelines closely follows the model of [GitHub pull-reque
1111

1212
## Pull-request guidelines
1313
* target the **develop** branch for integration
14-
* ensure code [builds properly]( https://github.com/kknox/clSPARSE/wiki/Build ) across Windows, Linux and MacOSX
15-
* Cloud based build services will verify pull requests
14+
* ensure code builds successfully.
1615
* do not break existing test cases
17-
* new functionality will only be merged with new test cases
18-
* new tests should integrate within the existing [googletest framework](https://github.com/google/googletest/blob/master/googletest/docs/Primer.md)
16+
* new functionality will only be merged with new unit tests
17+
* new unit tests should integrate within the existing [googletest framework](https://github.com/google/googletest/blob/master/googletest/docs/Primer.md)
18+
* tests must have good code coverage
19+
* code must also have benchmark tests, and performance must approach the compute bound limit or memory bound limit.
1920

2021
## StyleGuide
2122
This project follows the [CPP Core guidelines](https://github.com/isocpp/CppCoreGuidelines/blob/master/CppCoreGuidelines.md), with few modifications or additions noted below. All pull-requests should in good faith attempt to follow the guidelines stated therein, but we recognize that the content is lengthy. Below we list our primary concerns when reviewing pull-requests.
2223

2324
### Interface
2425
- All public APIs are C89 compatible; all other library code should use c++14
2526
- Our minimum supported compiler is clang 3.6
26-
- [NL.10](https://github.com/kknox/CppCoreGuidelines/blob/master/CppCoreGuidelines.md#Rl-camel): Avoid CamelCase
27+
- Avoid CamelCase
2728
- This rule applies specifically to publicly visible APIs, but is also encouraged (not mandated) for internal code
2829

2930
### Philosophy

0 commit comments

Comments
 (0)