Skip to content

Commit 6847bc0

Browse files
committed
updated README badge for GH and added Contributing section
1 parent 386c100 commit 6847bc0

1 file changed

Lines changed: 15 additions & 1 deletion

File tree

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# MDAnalysisData
22

3-
[![Build Status](https://travis-ci.com/MDAnalysis/MDAnalysisData.svg?branch=master)](https://travis-ci.com/MDAnalysis/MDAnalysisData)
3+
[![Build Status](https://github.com/MDAnalysis/MDAnalysisData/actions/workflows/gh-ci.yaml/badge.svg)](https://github.com/MDAnalysis/GridDataFormats/actions/workflows/ci.yaml)
44
[![codecov](https://codecov.io/gh/MDAnalysis/MDAnalysisData/branch/master/graph/badge.svg)](https://codecov.io/gh/MDAnalysis/MDAnalysisData)
55
[![docs](https://img.shields.io/badge/docs-latest-brightgreen.svg)](https://www.mdanalysis.org/MDAnalysisData/)
66
[![PRs welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
@@ -72,6 +72,20 @@ The data directory can we wiped with the function
7272
MDAnalysisData.base.clear_data_home()
7373
```
7474

75+
## Contributing new datasets
76+
77+
Please add new datasets to MDAnalysisData. See [Contributing new
78+
datasets](https://www.mdanalysis.org/MDAnalysisData/contributing.html)
79+
for details, but in short:
80+
81+
1. raise an issue in the [issue
82+
tracker](https://github.com/MDAnalysis/MDAnalysisData/issues) describing
83+
what you want to add; this issue will become the focal point for discussions
84+
where the developers can easily give advice
85+
2. deposit data in an archive under an [Open
86+
Data](https://opendatacommons.org/) compatible license (CC0 or
87+
CC-BY preferred)
88+
3. write accessor code in MDAnalysisData
7589

7690

7791
## Credits

0 commit comments

Comments
 (0)