-
Notifications
You must be signed in to change notification settings - Fork 13
Fix/macos boost cmake for osx #271
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
Open
msettles
wants to merge
5
commits into
master
Choose a base branch
from
fix/macos-boost-cmake
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| # Repository Guidelines | ||
|
|
||
| ## Project Structure & Module Organization | ||
| - Core shared code in `common/src` with unit tests in `common/test`; executables live in tool-specific folders (`hts_AdapterTrimmer`, `hts_SuperDeduper`, etc.), each with `src/`, `test/`, and a local `README` describing options. | ||
| - CMake configuration lives in the repo root and `cmake/`; third-party archives (googletest) are in `ext/`. | ||
| - `regression/` holds small FASTQ fixtures and expected outputs for end-to-end checks. Build artifacts should stay outside the repo (e.g., `build/`). | ||
|
|
||
| ## Build, Test, and Development Commands | ||
| - Configure an out-of-source build: `cmake -S . -B build -DCMAKE_BUILD_TYPE=Release` (add `-DBUILD_STATIC_BIN=ON` for static Linux binaries or `-DBUILD_GPERFTOOLS=ON` when profiling). | ||
| - Compile: `cmake --build build -j$(nproc)`; copy of `compile_commands.json` is generated for tooling. | ||
| - Unit tests: `ctest --test-dir build` (or `cmake --build build --target test` / `make test` inside `build`). | ||
| - Regression check after building: `cd regression && ./regression.sh ../build test` to compare outputs against fixtures. | ||
|
|
||
| ## Coding Style & Naming Conventions | ||
| - C++11 codebase compiled with `-Wall -Werror` (and `-Wextra` on Clang); keep code warning-clean. | ||
| - Prefer 4-space indentation, Allman-style braces, and explicit `std::`/`boost::` qualifiers; headers guard with `#ifndef/#define`. | ||
| - Executable targets follow `hts_*` naming; tests mirror module names (e.g., `hts_TestQWindowTrim.cpp`). | ||
| - Use existing option-parsing helpers in `common/src/utils.h` and keep new flags documented in the module `README`. | ||
|
|
||
| ## Testing Guidelines | ||
| - Unit tests use GoogleTest (vendored under `ext/googletest`); place new cases in the module’s `test/` folder and keep filenames consistent with the tool under test. | ||
| - When behavior depends on streaming order, add deterministic sorting (see `regression/regression.sh` handling for `hts_SuperDeduper`). | ||
| - For new CLI flags, include tests covering default behavior, error handling (invalid parameters), and representative FASTQ inputs. | ||
|
|
||
| ## Commit & Pull Request Guidelines | ||
| - Commit messages are short and imperative (e.g., “Fix clang warnings”, “Update release doc”); reference issues with `#123` when relevant. | ||
| - Before opening a PR, run unit tests and regression checks, and update version info (`common/src/version.h.release`) only when preparing a release branch. | ||
| - PRs should summarize the change, outline user-visible flags or defaults that shifted, note test coverage, and link any tracking issue. Include sample commands if the workflow changes. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
why this change? was something wrong with the hash before?