Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Example docs #107

Merged
merged 14 commits into from Feb 23, 2022
2 changes: 1 addition & 1 deletion .github/workflows/github-ci.yml
Expand Up @@ -46,7 +46,7 @@ jobs:
steps:
- uses: actions/checkout@v2
# Required for pre-commit
- run: pip3 install cpplint
- run: pip3 install cpplint==1.5.5
# NOTE: This is deprecated in favor of pre-commit.ci
- uses: pre-commit/action@v2.0.2
with:
Expand Down
10 changes: 7 additions & 3 deletions CONTRIBUTING.md
@@ -1,14 +1,17 @@
# Pull Requests

Intel HEXL welcomes pull requests from external contributors to the `development` branch.
Intel HE Acceleration Library (HEXL) welcomes pull requests from external
contributors to the `development` branch.

Before contributing, please run
```bash
cmake --build build --target check unittest
```
to make sure the formatting checks and all unit tests pass.

Please sign your commits before making a pull request. See instructions [here](https://docs.github.com/en/github/authenticating-to-github/managing-commit-signature-verification/signing-commits) for how to sign commits.
Please sign your commits before making a pull request. See instructions
[here](https://docs.github.com/en/github/authenticating-to-github/managing-commit-signature-verification/signing-commits)
for how to sign commits.

### Known Issues ###

Expand All @@ -25,4 +28,5 @@ Please sign your commits before making a pull request. See instructions [here](h
error: gpg failed to sign the data
fatal: failed to write commit object
```
Try adding ```export GPG_TTY=$(tty)``` to `~/.bashrc`.
Try adding ```export GPG_TTY=$(tty)``` to your shell initializer script such
as `~/.bashrc`.