Skip to content

Commit 12b897a

Browse files
authored
Merge pull request #39 from JPTIZ/add-cff
Add CFF file and citation guidelines
2 parents 3d2e6fc + 8108bfc commit 12b897a

File tree

2 files changed

+49
-6
lines changed

2 files changed

+49
-6
lines changed

CITATION.cff

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# YAML 1.2
2+
# Metadata for citation of this software according to the CFF format (https://citation-file-format.github.io/)
3+
cff-version: 1.0.3
4+
message: If you use this software, please cite it using these metadata.
5+
title: 'Code is Science Manifesto: First Release'
6+
doi: 10.5281/zenodo.3484107
7+
authors:
8+
- given-names: Yo
9+
family-names: Yehudi
10+
affiliation: '@intermine at the University of Cambridge'
11+
- given-names: Selina
12+
family-names: Aragon
13+
- given-names: Yee
14+
family-names: Mun
15+
- given-names: Alexander
16+
family-names: Konovalov
17+
affiliation: University of St Andrews
18+
- given-names: Vince
19+
family-names: Knight
20+
affiliation: Cardiff University, School of Mathematics
21+
- given-names: Philippe
22+
family-names: Rivière
23+
affiliation: Visionscarto.net
24+
- given-names: Egon
25+
family-names: Willighagen
26+
affiliation: '@BiGCAT-UM'
27+
- given-names: Chris
28+
family-names: Ilozulu
29+
- given-names: Alexander
30+
family-names: Morley
31+
affiliation: MRC BNDU (University of Oxford)
32+
version: '1.0'
33+
date-released: 2019-10-13
34+
repository-code: https://github.com/codeisscience/manifesto
35+
license: CC0-1.0
36+
url: https://codeisscience.github.io/manifesto/

README.md

+13-6
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22

33
**TL;DR: Scientific code needs to be open source in order to be useful and peer reviewed.**
44

5-
65
## Support The Manifesto
76
Right now we're in the [60 day consultation period](roadmap.md) to allow potentially interested parties to comment on the manifesto draft before we officially begin to collect signatures.
87

@@ -12,23 +11,31 @@ If you'd like to comment on the draft during the consultation period, you can do
1211

1312
- Fill out [this form](https://goo.gl/forms/dgvUjzkEYJqJJJrx2) with your feedback comments.
1413
- Create a [GitHub issue](https://github.com/codeisscience/manifesto/issues/new?title=[Manifesto%20Comment]) (requires GitHub account).
15-
- [Fork the repo](https://github.com/codeisscience/manifesto/fork) and create a pull request with suggested amendments.
14+
- [Fork the repo](https://github.com/codeisscience/manifesto/fork) and create a pull request with suggested amendments.
1615

1716
## Mailing list
1817

19-
[Sign up for updates on the Code is Science Manifesto](https://goo.gl/forms/gzd3dugLkZV92gms1).
18+
[Sign up for updates on the Code is Science Manifesto](https://goo.gl/forms/gzd3dugLkZV92gms1).
2019

2120
## Badges
22-
After signing, you can add ![https://img.shields.io/badge/Code%20is%20Science%20Manifesto-%E2%9C%93-brightgreen.svg](https://img.shields.io/badge/Code%20is%20Science%20Manifesto-%E2%9C%93-brightgreen.svg) to all your Github projects and your profile. Remember to link back to the [Code is Science Manifesto](https://codeisscience.github.io/manifesto/) page.
21+
After signing, you can add ![https://img.shields.io/badge/Code%20is%20Science%20Manifesto-%E2%9C%93-brightgreen.svg](https://img.shields.io/badge/Code%20is%20Science%20Manifesto-%E2%9C%93-brightgreen.svg) to all your Github projects and your profile. Remember to link back to the [Code is Science Manifesto](https://codeisscience.github.io/manifesto/) page.
2322

2423
```
2524
![https://img.shields.io/badge/Code%20is%20Science%20Manifesto-%E2%9C%93-brightgreen.svg](https://img.shields.io/badge/Code%20is%20Science%20Manifesto-%E2%9C%93-brightgreen.svg)
2625
```
2726

2827
## Contributors
29-
We are in the process of requesting permission to publish a full list of contributors.
28+
We are in the process of requesting permission to publish a full list of contributors.
3029

3130
### Stickers
32-
Stickers will be available soon.
31+
Stickers will be available soon.
32+
33+
## Citation
3334

35+
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3484107.svg)](https://doi.org/10.5281/zenodo.3484107)
3436

37+
Every release of this repository has a DOI related to it. You can either cite
38+
it directly or, more preferably, use the [CITATION.cff](./CITATION.cff) file
39+
along with [a tool](https://citation-file-format.github.io/#/tools) to properly
40+
use it (such as for [BibTeX generation from CFF
41+
file](https://github.com/citation-file-format/cff-converter-python)).

0 commit comments

Comments
 (0)