Skip to content

Commit 0b3802f

Browse files
committed
reworded section on checking changes
1 parent 31ffb81 commit 0b3802f

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

.github/CONTRIBUTING.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,13 @@ This template is a place to pull together agreed best practices from various sou
1111

1212
## Checking your changes before making a PR
1313

14-
The template has some tests that generating from scratch and updating the [example](https://github.com/DiamondLightSource/python-copier-template-example) produce the same result, but it is difficult to that things like CI and docs are still generated correctly. You can ease this process by:
14+
The template has tests for:
15+
16+
- Generating a new project from scratch
17+
- Updating the [example project](https://github.com/DiamondLightSource/python-copier-template-example)
18+
- Checking that both of the above produce the same results
19+
20+
However, this does not test whether processes like CI and docs work correctly. To ensure that this can be checked, you can:
1521

1622
- Making your changes on a branch of <https://github.com/DiamondLightSource/python-copier-template>
1723
- Running `copier update --vcs-ref=<branch_name>` in the repo where you would like to demonstrate the behaviour

0 commit comments

Comments
 (0)