Skip to content

Commit

Permalink
docs: Add initial usage information to README
Browse files Browse the repository at this point in the history
  • Loading branch information
gteufelberger committed May 12, 2024
1 parent 444ce18 commit 0cff219
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,24 @@
# helios-procedures
LaTeX source for HELIOS related procedures

To get the procedures, go to the [release page on right side](https://github.com/aris-space/helios-procedures/releases) and download it from the release assets.

## Usage

### Doing changes

Commit messages should follow [conventional commit message structure](https://www.conventionalcommits.org/)

TODO: examples

Changes should be small and atomic.
Basically make many small PRs rather than one big one.

⚠️ Note that the `main` branch is protected, all changes have to be made to new branches and then merged via a [pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) ⚠️

Whenenever there are unreleased changes on main, `tagpr` will create a new release pull request.
Merging that PR will automatically create a new release.

### Other

By default, documents will have a draft watermark controlled by a single LaTeX variable unless they are compiled by the release pipeline.

0 comments on commit 0cff219

Please sign in to comment.