Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
34 lines (21 loc) · 948 Bytes

CONTRIBUTING.md

File metadata and controls

34 lines (21 loc) · 948 Bytes
Raw

Contributing

Setup

To get a preview of the book you need to install the mdBook CLI.

cargo install mdbook
cargo install mdbook-katex

Start a development server, which will serve the book on http://<your-ip-address>:3000 (e.g. http://localhost:3000).

mdbook serve --open

Guidelines

Commits

Please adhere to https://www.conventionalcommits.org/en/v1.0.0/ when writing commit messages.

If you are working on a particular chapter the scope should always be of the form C3.5. For example if you make some minor improvements in chapter 3.5, your commit message should look like this:

chore(C3.5): minor improvements

Branches

Branch names should be lisp-case and should start with the chapter name the feature of fix applies to.

For example if you fix a typo in Chapter 1.5, the branch name should be c-01-05-fix-typo.