You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
If you need a specific sub-module, reference this explicitly based on `ski`. For example:
95
+
96
+
```python
97
+
import skimage as ski
98
+
rr, cc = ski.draw.rectangle(start=(357, 44), end=(740, 720))
99
+
```
100
+
101
+
- For reading and writing images use the [imageio](https://imageio.readthedocs.io/en/stable/index.html) library, and avoid use of `skimage.io`. For example:
102
+
```python
103
+
import imageio.v3 as iio
104
+
chair = iio.imread(uri="data/chair.jpg") # read an image
105
+
iio.imwrite(uri="data/chair.tif", image=chair) # write an image
106
+
```
107
+
108
+
- Comments providing an overall description of a code snippet, should use triple quotes `"""` e.g.
109
+
```python
110
+
"""Python script to load a colour image in grayscale"""
111
+
112
+
chair = iio.imread(uri="data/chair.jpg")
113
+
gray_chair = skimage.color.rgb2gray(chair)
114
+
```
115
+
116
+
### What *Not* to Contribute (General)
62
117
63
118
Our lessons already contain more material than we can cover in a typical
64
119
workshop, so we are usually *not* looking for more concepts or tools to add to
@@ -72,6 +127,22 @@ platform. Our workshops typically contain a mixture of Windows, macOS, and
72
127
Linux users; in order to be usable, our lessons must run equally well on all
73
128
three.
74
129
130
+
### What *Not* to Contribute (This Lesson)
131
+
132
+
Although most contributions will be welcome at this stage of the curriculum's development,
133
+
the time available to deliver the content in a training event is strictly limited
134
+
and needs to be accounted for when considering the addition of any new content.
135
+
If you want to suggest the addition of new content, especially whole new sections or episodes,
136
+
please open an issue to discuss this with the Maintainers first and provide the following information alongside a summary of the content to be added:
137
+
138
+
1. A suggested location for the new content.
139
+
2. An estimate of how much time you estimate the new content would require in training
140
+
(teaching + exercises).
141
+
3. The [learning objective(s)][cldt-lo] of this new content.
142
+
4. (optional, but strongly preferred)
143
+
A suggestion of which of the currently-used learning objectives could be
144
+
removed from the curriculum to make space for the new content.
145
+
75
146
### Using GitHub
76
147
77
148
If you choose to contribute via GitHub, you may want to look at [How to
@@ -92,6 +163,14 @@ Each lesson has a team of maintainers who review issues and pull requests or
92
163
encourage others to do so. The maintainers are community volunteers, and have
93
164
final say over what gets merged into the lesson.
94
165
166
+
#### Merging Policy
167
+
168
+
Pull requests made to the default branch of this repository
169
+
(from which the lesson site is built)
170
+
can only be merged after at least one approving review from a Maintainer.
171
+
Any Maintainer can merge a pull request that has received at least one approval,
172
+
but they may prefer to wait for further input from others before merging.
173
+
95
174
### Other Resources
96
175
97
176
The Carpentries is a global organisation with volunteers and learners all over
@@ -102,6 +181,7 @@ media, slack, newsletters, and email lists. You can also [reach us by
0 commit comments