Skip to content

Commit

Permalink
Add contributing guide
Browse files Browse the repository at this point in the history
  • Loading branch information
m-wild committed Aug 4, 2020
1 parent fb0fb57 commit 05ff856
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 1 deletion.
28 changes: 28 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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)

3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 05ff856

Please sign in to comment.