-
-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
8775dd0
commit a2cfe05
Showing
5 changed files
with
120 additions
and
80 deletions.
There are no files selected for viewing
This file contains 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,57 @@ | ||
| # Contribution Guidelines | ||
|
|
||
| ## Branching Scheme | ||
|
|
||
| This repository employs a [trunk-based development](https://trunkbaseddevelopment.com/): development occurs on `development` branch with short-lived branches that merges into it. | ||
| When a release is met, for example a `v0.3.2` release, a `v0.3.x` branch is spun of `development` and the release tagged. If this branch already exists, relevant commits are back-ported instead. | ||
|
|
||
| > [!INFO] | ||
| > We don't literally stick to it as the pace is too slow to justify branching for each release. | ||
| Development is done towards `development`. | ||
|
|
||
| ### Working branches naming scheme | ||
|
|
||
| While we don't care how you name branches in your forks, we encourage you to branch not PR `development` from your fork, however, if you're a contributor working on this repo directly we strongly | ||
| advice to name your branches with following format `issue/99/short-kebab-case-name`, where `99` is the number of issue you're trying to fix or address as enhancement. The work `issue` may be | ||
| replaced by `bugfix` if you're fixing a bug, or `feature` if you're working on enhancement. | ||
|
|
||
| ## Developing with PAC changes aside | ||
|
|
||
| PACs used by HAL in this repository now reside in [atsamx7x-pac](https://github.com/atsams-rs/atsamx7x-pac/) repository. Crates are published from there to crates.io, and released versions | ||
| are normally enough to work with HAL. | ||
|
|
||
| However, if you're in need to incorporate some changes related to unreleased PACs, own variants of PACs, or you fix broken HAL after `svd2rust` generated breaking changes, you have to: | ||
| 1. Clone the PACs repository to the directory one level above this one: | ||
| ```sh | ||
| git clone git@github.com/atsams-rs/atsamx7x-pac.git ../atsamx7x-pac | ||
| ``` | ||
|
|
||
| 2. Add `[patch.crates]` section to `.cargo/config`, for example: | ||
| ```toml | ||
| [patch.crates-io] | ||
| # This is example for one PAC kind, you may want to repeat for each you're using | ||
| atsamv71q21b = { path = "../../atsamx7x-pac/pac/atsamv71q21b" } | ||
| ``` | ||
| or try to run: | ||
| ```sh | ||
| tools/patch-pacs | ||
| ``` | ||
| > [!WARN] | ||
| > Please don't commit this change! | ||
| This feature is documented [here](https://doc.rust-lang.org/cargo/reference/config.html#patch). | ||
|
|
||
| 3. Make changes in there and (re)generate (in this directory; with Python 3 installed): | ||
| ```sh | ||
| pushd ../atsamx7x-pac | ||
| tools/pacs.py svd | ||
| popd | ||
| ``` | ||
|
|
||
| ## Pull Requests | ||
|
|
||
| When you submit a **Pull Request** make sure you've described your efforts in `CHANGELOG.md`, otherwise CI will fail. | ||
|
|
||
| Code has to be formatted with `cargo rustfmt`, otherwise CI will fail. | ||
|
|
This file contains 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 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 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 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,51 @@ | ||
| #!/usr/bin/env bash | ||
|
|
||
| set -euo pipefail | ||
|
|
||
| declare -r REPO=$(git rev-parse --show-toplevel) | ||
| declare -r CARGO_CONFIG="${REPO}/.cargo/config" | ||
|
|
||
| if grep -q "\[patch.crates-io\]" "${CARGO_CONFIG}" ; then | ||
| echo "Error: The [patch] section is already in \`${CARGO_CONFIG}\`" >&2 | ||
| exit 1 | ||
| fi | ||
|
|
||
| cat <<EOF >> ${CARGO_CONFIG} | ||
| [patch.crates-io] | ||
| atsame70j19b = { path = "../../atsamx7x-pac/pac/atsame70j19b" } | ||
| atsame70j20b = { path = "../../atsamx7x-pac/pac/atsame70j20b" } | ||
| atsame70j21b = { path = "../../atsamx7x-pac/pac/atsame70j21b" } | ||
| atsame70n19b = { path = "../../atsamx7x-pac/pac/atsame70n19b" } | ||
| atsame70n20b = { path = "../../atsamx7x-pac/pac/atsame70n20b" } | ||
| atsame70n21b = { path = "../../atsamx7x-pac/pac/atsame70n21b" } | ||
| atsame70q19b = { path = "../../atsamx7x-pac/pac/atsame70q19b" } | ||
| atsame70q20b = { path = "../../atsamx7x-pac/pac/atsame70q20b" } | ||
| atsame70q21b = { path = "../../atsamx7x-pac/pac/atsame70q21b" } | ||
| atsams70j19b = { path = "../../atsamx7x-pac/pac/atsams70j19b" } | ||
| atsams70j20b = { path = "../../atsamx7x-pac/pac/atsams70j20b" } | ||
| atsams70j21b = { path = "../../atsamx7x-pac/pac/atsams70j21b" } | ||
| atsams70n19b = { path = "../../atsamx7x-pac/pac/atsams70n19b" } | ||
| atsams70n20b = { path = "../../atsamx7x-pac/pac/atsams70n20b" } | ||
| atsams70n21b = { path = "../../atsamx7x-pac/pac/atsams70n21b" } | ||
| atsams70q19b = { path = "../../atsamx7x-pac/pac/atsams70q19b" } | ||
| atsams70q20b = { path = "../../atsamx7x-pac/pac/atsams70q20b" } | ||
| atsams70q21b = { path = "../../atsamx7x-pac/pac/atsams70q21b" } | ||
| atsamv70j19b = { path = "../../atsamx7x-pac/pac/atsamv70j19b" } | ||
| atsamv70j20b = { path = "../../atsamx7x-pac/pac/atsamv70j20b" } | ||
| atsamv70n19b = { path = "../../atsamx7x-pac/pac/atsamv70n19b" } | ||
| atsamv70n20b = { path = "../../atsamx7x-pac/pac/atsamv70n20b" } | ||
| atsamv70q19b = { path = "../../atsamx7x-pac/pac/atsamv70q19b" } | ||
| atsamv70q20b = { path = "../../atsamx7x-pac/pac/atsamv70q20b" } | ||
| atsamv71j19b = { path = "../../atsamx7x-pac/pac/atsamv71j19b" } | ||
| atsamv71j20b = { path = "../../atsamx7x-pac/pac/atsamv71j20b" } | ||
| atsamv71j21b = { path = "../../atsamx7x-pac/pac/atsamv71j21b" } | ||
| atsamv71n19b = { path = "../../atsamx7x-pac/pac/atsamv71n19b" } | ||
| atsamv71n20b = { path = "../../atsamx7x-pac/pac/atsamv71n20b" } | ||
| atsamv71n21b = { path = "../../atsamx7x-pac/pac/atsamv71n21b" } | ||
| atsamv71q19b = { path = "../../atsamx7x-pac/pac/atsamv71q19b" } | ||
| atsamv71q20b = { path = "../../atsamx7x-pac/pac/atsamv71q20b" } | ||
| atsamv71q21b = { path = "../../atsamx7x-pac/pac/atsamv71q21b" } | ||
| EOF | ||
|
|
||
| echo "Development patching added to \`${CARGO_CONFIG}\`." |