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

README correction to docs path & additional gitignore to macos + vscode #1503

Merged
merged 3 commits into from
Jul 2, 2023

Conversation

planetf1
Copy link
Contributor

@planetf1 planetf1 commented Jun 29, 2023

  1. Add common macOS filetype to .gitignore to avoid accidental checkins
  2. Add visual studio code / jetbrains IDE config file location to .gitignore as above
  3. Correction to readme - path to generated documentation was incorrect

Both are very minor, but things I noticed when using liboqs for the first time, and walking through the documentation.
Hope this really small contribution helps & is appropriate.

I can also squash or re-edit to follow appropriate guidelines if needed

  • Does this PR change the input/output behaviour of a cryptographic algorithm (i.e., does it change known answer test values)? (If so, a version bump will be required from x.y.z to x.(y+1).0.) -> NO
  • Does this PR change the list of algorithms available -- either adding, removing, or renaming? Does this PR otherwise change an API? (If so, PRs in oqs-provider, OQS-OpenSSL, OQS-BoringSSL, and OQS-OpenSSH will also need to be ready for review and merge by the time this is merged.) -> NO

No tests executed - this is just a Readme & .gitignore update

@planetf1 planetf1 requested a review from dstebila as a code owner June 29, 2023 14:49
@planetf1 planetf1 changed the title Upd1 README correction to docs path & additional gitignore to macos + vscode Jun 29, 2023
Copy link
Member

@baentsch baentsch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks for the contribution!

@dstebila dstebila merged commit 93e7847 into open-quantum-safe:main Jul 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants