Skip to content

Commit 152a2af

Browse files
milancurcicselipot
andauthored
Add a short contributing guide and scope (#292)
* Add a short contributing guide and scope * Grammar * added links and edit --------- Co-authored-by: Shane Elipot <[email protected]>
1 parent d8ba7a9 commit 152a2af

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,36 @@ Example Jupyter notebooks that showcase the library, as well as scripts
117117
to process various Lagrangian datasets, can be found in
118118
[clouddrift-examples](https://github.com/Cloud-Drift/clouddrift-examples), [gdp-get-started](https://github.com/Cloud-Drift/gdp-get-started), [mosaic-get-started](https://github.com/Cloud-Drift/mosaic-get-started), or [a demo for the EarthCube community workshop 2023](https://github.com/Cloud-Drift/e3-comm-workshop-2023).
119119

120+
## Contributing and scope
121+
122+
We welcome contributions from the community.
123+
If you would like to propose an idea for a new feature or contribute your own
124+
implementation, please follow these steps:
125+
126+
1. Open a new [issue](https://github.com/Cloud-Drift/clouddrift/issues) to discuss your proposal.
127+
2. Once we agree on a general way forward, [fork the repository](https://docs.github.com/en/github-ae@latest/get-started/quickstart/fork-a-repo) and [create a
128+
new branch](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository) for your contribution.
129+
3. Write your code and [tests](https://docs.github.com/en/actions/automating-builds-and-tests). Please follow the same style as the rest of the
130+
codebase and ensure that all new functionality is covered by your tests.
131+
4. Open a pull request and request a review.
132+
133+
The scope of CloudDrift includes:
134+
135+
* Working with contiguous ragged-array data; for example, see the
136+
[`clouddrift.ragged`](https://cloud-drift.github.io/clouddrift/_autosummary/clouddrift.ragged.html) module.
137+
* Common scientific analysis of Lagrangian data, oceanographic or otherwise;
138+
for example, see the
139+
[`clouddrift.kinematics`](https://cloud-drift.github.io/clouddrift/_autosummary/clouddrift.kinematics.html),
140+
[`clouddrift.signal`](https://cloud-drift.github.io/clouddrift/_autosummary/clouddrift.signal.html), and
141+
[`clouddrift.wavelet`](https://cloud-drift.github.io/clouddrift/_autosummary/clouddrift.wavelet.html) modules.
142+
* Processing existing Lagrangian datasets into a common data structure and format;
143+
for example, see the [`clouddrift.adapters.mosaic`](https://cloud-drift.github.io/clouddrift/_autosummary/clouddrift.adapters.mosaic.html) module.
144+
* Making cloud-optimized ragged-array datasets easily accessible; for example,
145+
see the [`clouddrift.datasets`](https://cloud-drift.github.io/clouddrift/_autosummary/clouddrift.datasets.html) module.
146+
147+
If you have an idea that does not fit into the scope of CloudDrift but you think
148+
it should, please open an issue to discuss it.
149+
120150
## Found an issue or need help?
121151

122152
Please create a new issue [here](https://github.com/Cloud-Drift/clouddrift/issues/new)

0 commit comments

Comments
 (0)