Skip to content

Commit

Permalink
Merge branch 'main' into v0.2.x
Browse files Browse the repository at this point in the history
  • Loading branch information
grst authored Nov 28, 2023
2 parents 582c769 + 3b088cd commit 9b534ce
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 7 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Scverse Cookiecutter Template

[![Test](https://github.com/scverse/cookiecutter-scverse/actions/workflows/test.yaml/badge.svg)](https://github.com/scverse/cookiecutter-scverse/actions/workflows/test.yaml)
[![Test][badge-test]][link-test]
[![Powered by NumFOCUS][badge-numfocus]][link-numfocus]

The purpose of this template is to get you started quickly building a best-practice python library for a [scverse][] ecosystem package.
Expand All @@ -25,6 +25,8 @@ Please consider making a tax-deductible [donation](https://numfocus.org/donate-t
>
</a>
[badge-test]: https://github.com/scverse/cookiecutter-scverse/actions/workflows/test.yaml/badge.svg
[link-test]: https://github.com/scverse/cookiecutter-scverse/actions/workflows/test.yaml
[badge-numfocus]: https://img.shields.io/badge/powered%20by-NumFOCUS-orange.svg?style=flat&colorA=E1523D&colorB=007D8A
[link-numfocus]: http://numfocus.org

Expand Down Expand Up @@ -94,12 +96,11 @@ We expect developers of scverse ecosystem packages to

## Changelog

See the [release section](https://github.com/scverse/cookiecutter-scverse/releases).
See the [release page][].

## Releasing a new template version

To release a new version of the template, create a new release
on the [GitHub release page](https://github.com/scverse/cookiecutter-scverse/releases).
To release a new version of the template, create a new release on the GitHub [release page][].
Choose a tag name of the format `vX.X.X` that adheres to [semantic versioning](https://semver.org/).

Note that when creating a new release, changes will be propagated to packages using this template.
Expand Down Expand Up @@ -131,3 +132,4 @@ You can cite the scverse publication as follows:
[codecov]: https://about.codecov.io/
[scverse discourse]: https://discourse.scverse.org/
[pytest]: https://docs.pytest.org
[release page]: https://github.com/scverse/cookiecutter-scverse/releases
6 changes: 3 additions & 3 deletions {{cookiecutter.project_name}}/docs/template_usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ While [codecov docs][] has a very extensive documentation on how to get started,
To set it up, simply go to the [codecov app][] page and follow the instructions to activate it for your repository.
Once the activation is completed, go back to the `Actions` tab and re-run the failing workflows.

The workflows should now succeed and you will be able to find the code coverage at this link: `https://app.codecov.io/gh/{{cookiecutter.github_user}}/{{cookiecutter.project_name}}`. You might have to wait couple of minutes and the coverage of this repository should be ~60%.
The workflows should now succeed, and you will be able to find the code coverage at this link: `https://app.codecov.io/gh/{{cookiecutter.github_user}}/{{cookiecutter.project_name}}`. You might have to wait a couple of minutes and the coverage of this repository should be ~60%.

If your repository is private, you will have to specify an additional token in the repository secrets. In brief, you need to:

Expand All @@ -150,7 +150,7 @@ On the RTD dashboard choose "Import a Project" and follow the instructions to ad

- Make sure to choose the correct name of the default branch. On GitHub, the name of the default branch should be `main` (it has
recently changed from `master` to `main`).
- We recommend to enable documentation builds for pull requests (PRs). This ensures that a PR doesn't introduce changes
- We recommend enabling documentation builds for pull requests (PRs). This ensures that a PR doesn't introduce changes
that break the documentation. To do so, got to `Admin -> Advanced Settings`, check the
`Build pull requests for this projects` option, and click `Save`. For more information, please refer to
the [official RTD documentation](https://docs.readthedocs.io/en/stable/pull-requests.html).
Expand Down Expand Up @@ -373,7 +373,7 @@ The following hints may be useful to work with the template sync:
## Moving forward
You have reached the end of this document. Congratulations! You have successfully set up your project and are ready to start.
For everything else related to documentation, code style, testing and publishing your project ot pypi, please refer to the [contributing docs](contributing.md#contributing-guide).
For everything else related to documentation, code style, testing and publishing your project to pypi, please refer to the [contributing docs](contributing.md#contributing-guide).
<!-- Links -->
Expand Down

0 comments on commit 9b534ce

Please sign in to comment.