Before submitting your pull requests, make sure you followed this list.
-
Read contributing guidelines.
-
Check if changes are consistent with the guidelines.
-
Check if changes are consistent with the coding style.
Before submitting your pull request for review, make sure your changes are consistent with project guidelines and coding style.
Contributed code must be:
-
Tested: Include tests when you contribute new features, as they help to a) prove that your code works correctly, and b) guard against future breaking changes to lower the maintenance cost. Bug fixes also generally require tests, because the presence of bugs usually indicates insufficient test coverage.
-
Documented: Pull requests that change documented functionality should update the relevant documentation. New functionality should be documented.
-
Portable: The project supports different operating systems CPU and GPU architectures, compilers, and run-times.
Include a license at the top of new files.
- Separate subject from body with a blank line
- Limit the subject line to 50 characters
- Capitalize the subject line
- Do not end the subject line with a period
- Use the imperative mood in the subject line
- Wrap the body at 72 characters
- Use the body to explain what and why vs. how
Further reading: How to Write a Git Commit Message
Install the Python modules required by the script\lint format checking script:
pip3 install -r requirements-dev.txt
Install Version 11.0.0 of clang-format by clicking on a link below to download. The file is named after the sha1 hash, rename it to clang-format.exe. Add its path to the PATH environment variable.
Windows binary (sha1: d4afd4eba27022f5f6d518133aebde57281677c9)
Linux binary (sha1: 1baf0089e895c989a311b6a38ed94d0e8be4c0a7)