Skip to content

Commit 5907466

Browse files
Merge pull request #101 from RoboStack/traversaro-patch-6
Contributing.md: document the unified vinca.yaml file
2 parents eac20e1 + ac4ca95 commit 5907466

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

docs/Contributing.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,11 @@ We follow the [NumFOCUS code of conduct](https://numfocus.org/code-of-conduct).
1818
# Adding new packages via pull requests
1919
You can open a pull request that will get build automatically in our CI.
2020

21-
An example can be found [here](https://github.com/RoboStack/ros-humble/pull/257). Simply add the required packages to the `vinca_*.yaml` files, where the `*` indicates the desired platform (`linux_64`, `linux_aarch64` (for ARM processors), `osx_64` (old Intel Macs), `osx_arm64` (Apple Silicon), or `win`). Ideally, try to add packages to all of these platforms. The name of the package is accepted both with underscores and dashes as word separators, but it is suggested to type the name of the package exactly as https://index.ros.org knows it.
21+
An example can be found [here](https://github.com/RoboStack/ros-humble/pull/257).
22+
23+
Depending on the distribution, you need to add the package either to a unified `vinca.yaml` file, or to multiple `vinca_*.yaml` files, where the `*` indicates the desired platform (`linux_64`, `linux_aarch64` (for ARM processors), `osx_64` (old Intel Macs), `osx_arm64` (Apple Silicon), or `win`). For the distributions with a unified `vinca.yaml` file, a package can be included or excluded by a given platform using `rattler-build`-style selectors, see https://rattler.build/dev/selectors/ .
24+
25+
Ideally, try to add packages to all of these platforms. The name of the package is accepted both with underscores and dashes as word separators, but it is suggested to type the name of the package exactly as https://index.ros.org knows it.
2226

2327
## Creating a new patch file
2428
Sometimes, it may be required to patch the packages. An example of how to do so can be found in [this PR](https://github.com/RoboStack/ros-noetic/pull/32). Generating the patch can be done as follows:

0 commit comments

Comments
 (0)