Skip to content

Commit f42d4a8

Browse files
committed
update 'contribute resources' guide
1 parent a44aa62 commit f42d4a8

File tree

1 file changed

+38
-20
lines changed

1 file changed

+38
-20
lines changed

docs/contributor_guide/contributing-new-resources.md

Lines changed: 38 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,10 @@ Use the same style and folder structure for images.
2626
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.
2727
If a section does not exist, create a new section (see other files for examples).
2828

29+
Please add an image of the resource to the `resources/library/img/<manufacturer>` folder.
30+
The image should have the same name as the resource definition you will create.
31+
The file type can be anything. Please compress and scale down the image to reduce its size (ideally below 100kB).
32+
2933
## 2. Document attribute sources
3034

3135
When writing a resource definition annotate each attribute with its origin.
@@ -37,26 +41,26 @@ If you measured a value yourself append `# measured`.
3741
# example
3842

3943
def AGenBio_96_wellplate_Ub_2200ul(name: str, lid: Optional[Lid] = None) -> Plate:
40-
"""
41-
AGenBio Catalog No. P-2.2-SQG-96
42-
- Material: Polypropylene
43-
- Max. volume: 2200 uL
44-
"""
45-
INNER_WELL_WIDTH = 8 # measured
46-
INNER_WELL_LENGTH = 8 # measured
47-
48-
well_kwargs = {
49-
"size_x": INNER_WELL_WIDTH, # measured
50-
...
51-
}
52-
53-
return Plate(
54-
name=name,
55-
size_x=127.76, # from spec
56-
size_y=85.48, # from spec
57-
size_z=42.5, # from spec
58-
...
59-
)
44+
"""
45+
AGenBio Catalog No. P-2.2-SQG-96
46+
- Material: Polypropylene
47+
- Max. volume: 2200 uL
48+
"""
49+
INNER_WELL_WIDTH = 8 # measured
50+
INNER_WELL_LENGTH = 8 # measured
51+
52+
well_kwargs = {
53+
"size_x": INNER_WELL_WIDTH, # measured
54+
...
55+
}
56+
57+
return Plate(
58+
name=name,
59+
size_x=127.76, # from spec
60+
size_y=85.48, # from spec
61+
size_z=42.5, # from spec
62+
...
63+
)
6064
````
6165

6266
## 3. Add imports
@@ -65,3 +69,17 @@ If you place your resource in a new module, remember to import it from the
6569
package's `__init__.py` so users can load it directly.
6670

6771
Thank you for helping expand the resource library!
72+
73+
## 4. Submit a pull request
74+
75+
Once you have:
76+
- [ ] added your resource to the library
77+
- [ ] documented the sources of your attributes (measured, from spec, etc.)
78+
- [ ] added the name, part number, link and image to the docs
79+
- [ ] added the imports
80+
- [ ] verified that your resource works as expected
81+
82+
You are ready to submit a pull request.
83+
84+
Please create a separate new pull request for each resource you add.
85+
This makes it easier to review and faster to merge.

0 commit comments

Comments
 (0)