From 05ff8566a33adcad13c471f10a0cd12cf43e58a7 Mon Sep 17 00:00:00 2001 From: Michael Wildman Date: Tue, 4 Aug 2020 21:26:50 +1200 Subject: [PATCH] Add contributing guide --- CONTRIBUTING.md | 28 ++++++++++++++++++++++++++++ README.md | 3 ++- 2 files changed, 30 insertions(+), 1 deletion(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..e35bd6f --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,28 @@ +# Contributing + +Feel free to get involved in the project by opening issues, or submitting pull requests. + + +## Build & Release Process + +Builds and releases managed with github actions. + +### Build + +* Local builds are as simple as `dotnet build && dotnet test` +* CI builds on every push +* [.github/workflows/ci.yaml](./.github/workflows/ci.yaml) +* Build and tests MUST pass before merging to master + + +### Release + +* Locally, packages can be created using `dotnet pack ./src/Saunter/Saunter.csproj` +* Release packages are built from github actions +* [.github/workflows/release.yaml](./.github/workflows/release.yaml) +* Pushing a tag formatted as `v*.*.*` will trigger the release workflow +* Releases MUST use semantic versioning +* Tags for release (non-preproduction) should relate to commits on `master` +* The repository owner is responsible for tagging and releasing +* Packages are pushed to [nuget.org/packages/saunter](https://www.nuget.org/packages/saunter) + diff --git a/README.md b/README.md index e4fa9a5..39d24d0 100644 --- a/README.md +++ b/README.md @@ -90,8 +90,9 @@ See [examples/StreetlightsAPI](examples/StreetlightsAPI). ## Contributing -Feel free to get involved in the project by opening issues, or submitting pull requests. +See our [contributing guide](./CONTRIBUTING.md). +Feel free to get involved in the project by opening issues, or submitting pull requests. ## Thanks