Skip to content

Commit 560a2e3

Browse files
authored
Edits; moved build topics to rst as get-started topics; improved navigation (#170)
* edits; moved build topics to rst as get-started topics; improved nav
1 parent a2b38e5 commit 560a2e3

File tree

9 files changed

+553
-334
lines changed

9 files changed

+553
-334
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# 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).
33

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).
55

66
## Pull Request Checklist
77

8-
Before sending your pull requests, ensure that you follow this checklist.
8+
Before sending your pull requests, ensure that you follow this checklist:
99

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.
1111

1212
* Ensure that your code includes proper documentation.
1313

@@ -25,7 +25,7 @@ oneMKL focuses on the following criteria:
2525

2626
2. *Generality*: Functionality is useful in a wide range of applications.
2727

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).
2929

3030
3. *Complexity*: Functionality that is not trivial to implement directly or by combining existing primitives.
3131

@@ -34,13 +34,13 @@ For the new API to become a part of the open source project, it should be accept
3434

3535
### RFC Issue
3636

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:
3838

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).
4040

4141
* The definition of the function including the interface and semantics, and how this interface will be extendable for different HW implementations.
4242

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.
4444

4545

4646
## Bug Reporting
@@ -50,16 +50,16 @@ If you find a bug or problem, please open a request under [Issues](https://githu
5050

5151
## Security Issues
5252

53-
Report security issues to [email protected]
53+
Report security issues to [email protected].
5454

5555

5656
## Coding Style
5757

58-
The general principle is to follow the style of existing / surrounding code. If you are in doubt, use the `clang-format`:
58+
The general principle is to follow the style of existing/surrounding code. If you are in doubt, use the `clang-format`:
5959
```sh
6060
clang-format -style=file -i foo.cpp
6161
```
62-
This formats code using the `_clang_format` file found in the oneMKL top level directory.
62+
This formats code using the `_clang_format` file found in the oneMKL top-level directory.
6363

6464

6565
### GN: General Naming

README.md

Lines changed: 10 additions & 315 deletions
Large diffs are not rendered by default.

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ To enable building documentation from the main build:
77
- Set `-o build_doc=True` when building with Conan. For more information see [Building with Conan](../README.md#building-with-conan)
88
- Set `-DBUILD_DOC=ON` when building with CMake. For more information see [Building with CMake](../README.md#building-with-cmake)
99

10-
To build documentation only use following cmake command from the current folder:
10+
To build documentation only, use the following commands from the current folder:
1111
```bash
1212
# Inside <path to onemkl>/docs
1313
mkdir build && cd build

0 commit comments

Comments
 (0)