-
Notifications
You must be signed in to change notification settings - Fork 57
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
30 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters