Skip to content

docs: update CPP contributing docs and .gitignore - #132

Open
piperchester wants to merge 9 commits into
spotify:mainfrom
piperchester:pc/update-build-docs
Open

piperchester wants to merge 9 commits into
spotify:mainfrom
piperchester:pc/update-build-docs

Conversation

@piperchester

@piperchester piperchester commented Oct 31, 2025 •

Copy link
Copy Markdown

Description

Small readability improvements to the CPP contributing docs. Code formatting, fixes, etc. Update .gitignore for cmake testing files as well.

Related Issues

N/A

Changes Made

  • Updated CONTRIBUTING.md with improved formatting and clarity for C++ build instructions
  • Added *_include-*.cmake pattern to cpp/test/.gitignore to exclude auto-generated CMake test files (e.g., VoyagerTests_include-<hash>.cmake)

Testing

N/A

Checklist

  • I have added and/or updated appropriate documentation (if applicable).

  • All new and existing tests pass locally with these changes.

  • I have run static code analysis (if available) and resolved any issues.

Additional Comments

These are minor documentation and configuration improvements that don't affect functionality. The .gitignore update prevents build artifacts from being accidentally committed.

@piperchester
piperchester marked this pull request as ready for review October 31, 2025 20:35

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

1 participant