Skip to content

Commit 2684c42

Browse files
committed
Update contributing guide
1 parent cf20dfb commit 2684c42

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,14 @@ premature-optimizations, or micro-optimizations.
1515
When contributing, please try to match the current code style in the codebase. Style doesn't matter
1616
too much ultimately but consistency within a codebase is important.
1717

18+
Please base changes against the `dev` branch, which is used for development.
19+
20+
## Code organization
21+
22+
The library's public interface is defined in headers in `include/`. Declarations for the public interface have
23+
definitions in .cpp files in the top-level of `src/`. Implementation for various actions such as unwinding, demangling,
24+
symbol resolution, etc. are put in various sub-directories of `src/`.
25+
1826
## Local development
1927

2028
The easiest way to get started with local development is running `make debug` (which automatically configures cmake and

0 commit comments

Comments
 (0)