Contributing to CPPX

Reporting Issues

• Check existing issues first.
• Include: code that caused the error, expected vs actual behavior.
• Security issues → see SECURITY.md, not a public issue.

Pull Requests

1. Fork → create branch (feature/my-feature)
2. Add tests in test_suite/
3. Build (cmake --build build) — this auto-formats and runs tests
4. Push → open PR to main

Keep PRs focused on one thing.

Adding a New Data Structure

CPPX is designed to grow. To add a new structure:

1. Header — declare the class in include/cppx.h (or a new header)
2. Implementation — add a .tpp file in src/ and #include it at the bottom of the header
3. Tests — add test_suite/<structure>_test_cases.cpp with Google Test cases
4. Benchmarks — add benchmarks to benchmarks/benchmark_main.cpp
5. Build — the CMake globs pick up new files automatically
6. Release — push to main, then run ./scripts/ppa-upload.sh

Code Guidelines

Structure

File Type	Purpose
.h (in include/)	Class declarations
.tpp (in src/)	Template implementations (included at bottom of .h)
.cpp (in test_suite/)	Unit tests (Google Test)

Naming

Entity	Style	Example
Classes	PascalCase	BinaryTree, AVLTree
Files	snake_case	binary_tree.tpp
Functions	snake_case	get_min(), insert_iterative()
Members	Prefixed	m_data, p_head

Rules

• All code in namespace stl_ext
• Memory is managed by NodePool (arena allocator) — no raw new/delete
• Use raw pointers for node links (not std::unique_ptr) — the arena owns all memory
• No using namespace std; in headers
• Template definitions go in .tpp files, not .cpp

Questions?

Open an issue or email via Code of Conduct.