Skip to content

Commit

Permalink
update docs (#7)
Browse files Browse the repository at this point in the history
add a releasing guide. and improve getting started.
  • Loading branch information
kiraware authored Feb 17, 2024
1 parent a709401 commit 8d90993
Showing 1 changed file with 30 additions and 1 deletion.
31 changes: 30 additions & 1 deletion docs/how-to-guides.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,34 @@ Basically it means that there is no need to rebase a Pull
Request against main branch. Just git merge main into your
working copy (a fork) if needed. The Pull Request is
automatically squashed into the single commit once the PR
is accepted. First clone the forked repository with the
is accepted.

The pull request submitted must be very specific so that
one pull request specifically describes one change.

First clone the forked repository with the
following command:

```console
git clone https://github.com/YOUR-USERNAME/PyBMKG
```

Then create a branch for pull requests in the fork
repository with a short branch name that explains in
general what pull request will be submitted. For
example in the following command:

```console
git branch fix-docs-typos
```

And don't forget to checkout and start making changes
from there.

```console
git checkout fix-docs-typos
```

After that, make sure your terminal's working directory
is active in the PyBMKG folder and [pre-commit](https://pre-commit.com/)
is installed globally. Then to install pre-commit git
Expand Down Expand Up @@ -104,3 +125,11 @@ command:
```console
poetry run mkdocs serve
```

### Releasing

We use the GitHub workflow to automatically release to PyPi when we
release to Github. The special environment for people who have access
to the workflow is in the Github environment with the name `production`.
Each release tag must be the same as `version` in `pyproject.toml` in
the `tool.poetry` section.

0 comments on commit 8d90993

Please sign in to comment.