You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+11-11Lines changed: 11 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,13 +1,13 @@
1
1
# Contributing Guidelines
2
-
If you have improvements, new libraries integrated under oneAPI Math Kernel Library (oneMKL) interfaces, or new interfaces to contribute to the oneMKL Specification, please send us your pull requests! For getting started, see GitHub [howto](https://help.github.com/en/articles/about-pull-requests).
2
+
If you have improvements, new libraries integrated under oneAPI Math Kernel Library (oneMKL) Interfaces, or new interfaces to contribute to the oneMKL Specification, please send us your pull requests! For getting started, see GitHub [howto](https://help.github.com/en/articles/about-pull-requests).
3
3
4
-
For how to enable new third-party library see the [guidelines](docs/create_new_backend.rst).
4
+
For how to enable a new third-party library, see the [guidelines](docs/create_new_backend.rst).
5
5
6
6
## Pull Request Checklist
7
7
8
-
Before sending your pull requests, ensure that you follow this checklist.
8
+
Before sending your pull requests, ensure that you follow this checklist:
9
9
10
-
* If you are contributing a new interface, refer to the [library functionality guidelines](CONTRIBUTING.md#library-functionality-guidelines). It is strongly advised that you first open a[RFC issue](CONTRIBUTING.md#RFC-issue) with a detailed explanation of the expected use cases.
10
+
* If you are contributing a new interface, refer to the [library functionality guidelines](CONTRIBUTING.md#library-functionality-guidelines). It is strongly advised that you first open an[RFC issue](CONTRIBUTING.md#RFC-issue) with a detailed explanation of the expected use cases.
11
11
12
12
* Ensure that your code includes proper documentation.
13
13
@@ -25,7 +25,7 @@ oneMKL focuses on the following criteria:
25
25
26
26
2.*Generality*: Functionality is useful in a wide range of applications.
27
27
28
-
This implies that when introducing a new function, its API needs to be general enough to be integrated into multiple applications that have similar functionality and its interface can support multiple hardware (HW).
28
+
This implies that when you introduce a new function, its API needs to be general enough to be integrated into multiple applications that have similar functionality and that its interface can support multiple hardware (HW).
29
29
30
30
3.*Complexity*: Functionality that is not trivial to implement directly or by combining existing primitives.
31
31
@@ -34,13 +34,13 @@ For the new API to become a part of the open source project, it should be accept
34
34
35
35
### RFC Issue
36
36
37
-
Open an Request For Comment (RFC) issue when contributing new interfaces. In the RFC, please provide the following details:
37
+
Open a Request For Comment (RFC) issue when contributing new interfaces. In the RFC, please provide the following details:
38
38
39
-
*Describe how the new interface meets [library functionality guidelines](CONTRIBUTING.md#library-functionality-guidelines).
39
+
*Description of how the new interface meets [library functionality guidelines](CONTRIBUTING.md#library-functionality-guidelines).
40
40
41
41
* The definition of the function including the interface and semantics, and how this interface will be extendable for different HW implementations.
42
42
43
-
* What existing libraries have implementation of this function and can be used under the oneMKL interface.
43
+
* What existing libraries have implementations of this function and can be used under the oneMKL interface.
44
44
45
45
46
46
## Bug Reporting
@@ -50,16 +50,16 @@ If you find a bug or problem, please open a request under [Issues](https://githu
0 commit comments