Skip to content

Commit 9505cbf

Browse files
committed
test resources before contributing
1 parent a1df799 commit 9505cbf

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

docs/contributor_guide/contributing-new-resources.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ PyLabRobot ships with a growing library of resource definitions for common labwa
44
If you define a new resource it helps the community when you contribute it back.
55
This page describes the information to include and how to format it.
66

7+
```{attention}
8+
PLEASE TEST YOUR RESOURCE DEFINITION BEFORE CONTRIBUTING!
9+
```
10+
711
## 1. Update the resource library
812

913
Add an entry for your resource under the appropriate manufacturer page in
@@ -19,6 +23,9 @@ Existing entries use a table format like this:
1923

2024
Use the same style and folder structure for images.
2125

26+
If a section for your resource type (e.g. "Plates"/"Troughs"/etc.) already exists, add your resource to it. Add no new line between the rows.
27+
If a section does not exist, create a new section (see other files for examples).
28+
2229
## 2. Document attribute sources
2330

2431
When writing a resource definition annotate each attribute with its origin.

0 commit comments

Comments
 (0)