Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
49 lines (34 loc) · 1.14 KB

CONTRIBUTING.md

File metadata and controls

49 lines (34 loc) · 1.14 KB
Raw

Contributing

Every contribution is welcome, such as:

  • Bug reports
  • Feature requests
  • Documentation improvement requests
  • Typo fixes
  • Performance discussions and improvements
  • New algorithm implementations
  • etc.

Please start by opening an issue.

Check the Development section for general guidance on the codebase.

Pull Requests should target the dev branch from a forked version of the repo.

This is an open source project created as the result of scientific teaching and research efforts. Please refrain from unrealistic expectations from maintainers.

Build

Just call build.sh or build.cmd depending on your OS.

Test

build.sh runtests
build.cmd runtests

Build ARCExpect packages

build.sh PackARCExpect
build.cmd PackARCExpect

The version, including any prerelease suffix, comes from ARCExpectPackageVersion in Directory.Build.props. Package publication uses the protected, manually dispatched GitHub Actions workflow documented in the release guide.