Skip to content

Latest commit

 

History

History
50 lines (34 loc) · 1.46 KB

CONTRIBUTING.md

File metadata and controls

50 lines (34 loc) · 1.46 KB
Raw

How to Contribute

Want to contribute? Great! First, read this page!

Formatting

Starlark files should be formatted by buildifier. We suggest using a pre-commit hook to automate this. First install pre-commit, then run

pre-commit install

Otherwise later tooling on CI may yell at you about formatting/linting violations.

Updating BUILD files

Some targets are generated from sources. Currently this is just the bzl_library targets. Run bazel run //:gazelle to keep them up-to-date.

Using this as a development dependency of other rules

You'll commonly find that you develop in another WORKSPACE, such as some other ruleset that depends on rules_dotnet, or in a nested WORKSPACE in the integration_tests folder.

To always tell Bazel to use this directory rather than some release artifact or a version fetched from the internet, run this from this directory:

OVERRIDE="--override_repository=rules_dotnet=$(pwd)/rules_dotnet"
echo "common $OVERRIDE" >> ~/.bazelrc

This means that any usage of @rules_dotnet on your system will point to this folder.

Running tests

To run and build all tests simply run bazel test //... To build and test all lexamples run cd examples && bazel test //...

Releasing

  1. Determine the next release version, following semver (could automate in the future from changelog)
  2. Tag the repo and push it (or create a tag in GH UI)
  3. Watch the automation run on GitHub actions