Skip to content

Commit ca81a88

Browse files
committed
Add forking instructions (including non-existent codecov)
fixes #4
1 parent 48e163e commit ca81a88

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

README.md

+7
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,13 @@ pytest
3737

3838
## Forking This Project
3939

40+
If you fork this project you should do the following things to make sure that your fork is correctly linked to your GitHub account:
41+
42+
1. If you haven't linked your GitHub account to [`codecov`](https://about.codecov.io/), do so now.
43+
2. Change the badge URL at the top of `README.md` to point to your GitHub workflow build. To do this, replace `flatironinstitute` with your GitHub handle in the URLs of the badge.
44+
3. Change the badge URL at the top of `README.md` to point to your [`codecov`](https://about.codecov.io/) report. Go to [`codecov`](https://about.codecov.io/), navigate to the `sciware-testing-python` project, then go to Settings > Badge.
45+
4. Change your [`codecov`](https://about.codecov.io/) token in your GitHub actions file (in `.github/workflows`). To get your token go to [`codecov`](https://about.codecov.io/), navigate to the `sciware-testing-python` project, then go to Settings > General > `Repository Upload Token`. Copy this token and use it to set the `CODECOV_TOKEN` variable in `.github/workflows`.
46+
4047
## Contents
4148

4249
* **[`README.md`](README.md)** - File generating this page.

0 commit comments

Comments
 (0)