Skip to content

Commit

Permalink
docs: add note on deleting the changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
yoctoyotta1024 committed Aug 30, 2024
1 parent f4ae440 commit 761d9f2
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
4 changes: 2 additions & 2 deletions docs/source/usage/cocogitto.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ Setting-Up Cocogitto
####################
This repository enables a few of cocogitto's optional features (see ``cog.toml``).
One is that the changelog is generated via GitHub's CI relative to the first tag called "v0.0.0". You
therefore need to add this tag to your GitHub repository, either on GitHub or by pushing the tag from
your local repository, e.g.
therefore need to delete any existing ``CHANGELOG.md`` and then add this tag to your GitHub repository,
either on GitHub or by pushing the tag from your local repository, e.g.

a. ``git tag -a v0.0.0 -m "init repo"``,
b. ``git push --tags``.
Expand Down
3 changes: 2 additions & 1 deletion docs/source/usage/getstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,10 +46,11 @@ Necessary first steps:
Necessary second steps:
#######################

#. Create and push the 0th version tag to the repository:
#. Create the 0th version tag in the remote repository:
a. ``git tag -a v0.0.0 -m "init repo"``,
b. ``git push --tags``.

#. Delete GoodSciProjTemplate's CHANGELOG.md ``rm CHANGELOG.md``.
#. Make the project name yours instead of "GoodSciProjTemplate".
#. Make the citation and liscence refer to you instead of me.
#. Corect the repository name and its owner for GitHub (e.g. in the CI.yaml).
Expand Down

0 comments on commit 761d9f2

Please sign in to comment.