diff options
| author | Cedric Nugteren <web@cedricnugteren.nl> | 2016-10-23 16:56:51 +0200 |
|---|---|---|
| committer | Cedric Nugteren <web@cedricnugteren.nl> | 2016-10-23 16:56:51 +0200 |
| commit | 43f4f023991e98eaf3abec32eef47ecbac14b4b9 (patch) | |
| tree | 92c2dc863432c41e098fa94bfd74a964bf9fe130 | |
| parent | b8d4a9b9d0b13c379da5dc470a0f8523f32d2e99 (diff) | |
Added an initial version of contributing guidelines
| -rw-r--r-- | CONTRIBUTING.md | 20 | ||||
| -rw-r--r-- | README.md | 2 |
2 files changed, 21 insertions, 1 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..9f698d32 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,20 @@ + +CLBlast: Contributing guidelines +================ + +For information about the CLBlast library, see the [README](README.md) file instead. + +Tuning results +------------- + +A [dedicated GitHub issue](https://github.com/CNugteren/CLBlast/issues/1) is available to post new tuning results. If you compiled with the tuners (see the [README](README.md) for instructions), ran one of the tuners on your device (or all perhaps?), and feel that these results should be included in the next release of CLBlast, please post them there. You can do this by attaching the JSON files to the issue (archived in a .ZIP file). + + +Code improvements and additions +------------- + +Pull requests are welcome as long as they: + +* Contain unit additions or modifications +* Follow the CLBlast coding style, which is loosely based on the [Google C++ style guide](https://google-styleguide.googlecode.com/svn/trunk/cppguide.html) and the Effective C++ books by Scott Meyers. We use a tab-size of 2 spaces and a max-width of 100 characters. +* Are made against the `development` branch. @@ -285,7 +285,7 @@ The `samples/haxpy.c` example shows how to use these convencience functions when Contributing ------------- -Contributions are welcome in the form of tuning results for OpenCL devices previously untested. Furthermore, merge requests are welcome as long as they contain unit additions or modifications. Furthermore, they should follow the CLBlast coding style, which is based on the [Google C++ style guide](https://google-styleguide.googlecode.com/svn/trunk/cppguide.html) and the Effective C++ books by Scott Meyers. +Contributions are welcome in the form of tuning results for OpenCL devices previously untested or pull requests. See [the contributing guidelines](CONTRIBUTING.md) for more details. The contributing authors (code, pull requests, testing) so far are: |