• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# Contributing to Boost.Compute #
2
3## Reporting Issues ##
4
5We value your feedback about issues you encounter. The more information you
6provide the easier it is for developers to resolve the problem.
7
8Issues should be reported to the [issue tracker](
9https://github.com/boostorg/compute/issues?state=open).
10
11Issues can also be used to submit feature requests.
12
13## Submitting Pull Requests ##
14
15Base your changes on `master` but submit your pull-request to `develop`. This
16can be changed by clicking the "Edit" button on the pull-request page. The
17develop branch is used for integration and testing of changes before merging
18into the stable `master` branch.
19
20Please try to rebase your changes on the current master branch before
21submitting. This keeps the git history cleaner and easier to understand.
22
23## Coding Style ##
24
25* Indentation is four-spaces (not tabs)
26* Try to keep line-length under 80 characters
27* Follow the STL/Boost naming conventions (e.g. lower case with underscores)
28* When in doubt, match the style of existing code
29* Otherwise, do whatever you want
30
31Also see the [Boost Library Requirements]
32(http://www.boost.org/development/requirements.html)).
33
34## Running Tests ##
35
36To build the tests you must enable the `BOOST_COMPUTE_BUILD_TESTS` option in
37`cmake`. The tests can be run by executing the `ctest` command from the build
38directory.
39
40Please report any tests failures to the issue tracker along with the test
41output and information on your system and compute device.
42
43## Support ##
44
45Feel free to send an email to kyle.r.lutz@gmail.com with any problems or
46questions.
47