-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Improve the README and add CONTRIBUTING
- Loading branch information
Showing
2 changed files
with
30 additions
and
16 deletions.
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,19 @@ | ||
# Guide to contributing to Ocplib-simplex | ||
|
||
## Release Process | ||
|
||
- Make a PR on `master` to initiate the release. The PR must introduce | ||
a new section in `CHANGES.md` with the new version number; | ||
- Once the PR is merged, create a new `vX.Y.Z` branch for the release from the | ||
current `master`. | ||
|
||
## Make the release | ||
|
||
The release is made using `dune-release`, and follows standard procedure for | ||
the tool: | ||
- `dune-release check` performs basic check; | ||
- `dune-release tag vX.Y.Z` creates a tag on the current branch; | ||
- `dune-release distrib` creates the distribution archive; | ||
- `dune-release publish` publishes the release on GitHub; | ||
- `dune-release opam pkg` creates an archive for opam; | ||
- `dune-release opam submit` opens a PR on the opam repository. |
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