diff options
author | Tom Milligan <tom.milligan@uipath.com> | 2023-12-18 13:25:57 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-12-18 13:25:57 +0100 |
commit | b1e6a5ee1ee2861abf037f15a44bd7529d21f2f2 (patch) | |
tree | f104c3ac93514f33f363ed4fae89ebee915224a2 | |
parent | dc219f755d63306ed0b02502925753c2411825c3 (diff) | |
parent | 0d7b64d1b8415cf43e741586c4b43dc260e89429 (diff) |
Merge pull request #164 from tommilligan/contributing
chore: split contributing guide
-rw-r--r-- | CONTRIBUTING.md | 31 | ||||
-rw-r--r-- | README.md | 25 |
2 files changed, 32 insertions, 24 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..83e9b9e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,31 @@ +# Contributing + +## Workflow + +Please submit a PR from a **new branch** in your fork. +Please do not submit a PR from your fork's `main` branch, as it makes collaborating on/editing the branch a pain. + +## Project design + +- Compiled CSS styles are built and committed from SCSS sources. See the `compile_assets` folder for details. +- `mdbook-admonish install` is responsible for delivering additional assets and configuration to a client book. +- `mdbook-admonish` is responsible for preprocessing book data, adding HTML that references compiled classnames. + +## Scripts to get started + +- `./scripts/install` installs other toolchains required for development +- `./scripts/check` runs a full CI check +- `./scripts/rebuild-book` rebuilds the reference book under `./book`. This is useful for integration testing locally. + +## Making breaking changes in CSS + +To make a breaking change in CSS, you should: + +- Update the assets version in `./src/bin/assets/VERSION` +- Update the required assets version specifier in `./src/REQUIRED_ASSETS_VERSION` + +You must make the next `mdbook-admonish` crate version at least a **minor** version bump. + +## Releasing + +Github workflows are setup such that pushing a `vX.Y.Z` tag will trigger a release to be cut. @@ -161,30 +161,7 @@ Guarantees provided are as follows: ## Development -Project design - -- Compiled CSS styles are built and committed from SCSS sources. See the `compile_assets` folder for details. -- `mdbook-admonish install` is responsible for delivering additional assets and configuration to a client book. -- `mdbook-admonish` is responsible for preprocessing book data, adding HTML that references compiled classnames. - -### Scripts to get started - -- `./scripts/install` installs other toolchains required for development -- `./scripts/check` runs a full CI check -- `./scripts/rebuild-book` rebuilds the reference book under `./book`. This is useful for integration testing locally. - -### Making breaking changes in CSS - -To make a breaking change in CSS, you should: - -- Update the assets version in `./src/bin/assets/VERSION` -- Update the required assets version specifier in `./src/REQUIRED_ASSETS_VERSION` - -You must make the next `mdbook-admonish` crate version at least a **minor** version bump. - -### Releasing - -Github workflows are setup such that pushing a `vX.Y.Z` tag will trigger a release to be cut. +See [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines on developing. ## Thanks |