Skip to content

Commit 7cac74e

Browse files
committed
Use GitHub's citation file
I'm not a fan of their inventing a new standard when bibtex already exists, and the web UI is broken at the moment, but it's still a net win for discoverability. Closes #3046.
1 parent f8932c4 commit 7cac74e

4 files changed

Lines changed: 67 additions & 37 deletions

File tree

‎CITATION‎

Lines changed: 0 additions & 34 deletions
This file was deleted.

‎CITATION.cff‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
cff-version: 1.2.0
2+
message: |
3+
If you use Hypothesis as part of a published research project,
4+
please cite our paper in the Journal of Open Source Software:
5+
6+
Text:
7+
8+
MacIver et al., (2019). Hypothesis: A new approach to property-based testing.
9+
Journal of Open Source Software, 4(43), 1891, https://doi.org/10.21105/joss.01891
10+
11+
BibTeX:
12+
13+
@article{MacIver2019Hypothesis,
14+
journal = {Journal of Open Source Software},
15+
doi = {10.21105/joss.01891},
16+
issn = {2475-9066},
17+
number = {43},
18+
publisher = {The Open Journal},
19+
title = {Hypothesis: A new approach to property-based testing},
20+
url = {http://dx.doi.org/10.21105/joss.01891},
21+
volume = {4},
22+
author = {MacIver, David and Hatfield-Dodds, Zac and Contributors, Many},
23+
pages = {1891},
24+
date = {2019-11-21},
25+
year = {2019},
26+
month = {11},
27+
day = {21},
28+
}
29+
30+
To reference a particular version of Hypothesis as a software artifact,
31+
you can use the version-specific DOIs we create for each release under
32+
https://doi.org/10.5281/zenodo.1412597
33+
34+
35+
preferred-citation:
36+
title: 'Hypothesis: A new approach to property-based testing'
37+
date-released: 2019-11-21
38+
type: article
39+
doi: 10.21105/joss.01891
40+
authors:
41+
- family-names: MacIver
42+
given-names: David R.
43+
orcid: https://orcid.org/0000-0002-8635-3223
44+
affiliation: Imperial College London
45+
- family-names: Hatfield-Dodds
46+
given-names: Zac
47+
orcid: https://orcid.org/0000-0002-8646-8362
48+
affiliation: Australian National University
49+
- name: "many other contributors"
50+
51+
# Citation metadata for the software itself, as required by the CFF spec
52+
doi: 10.5281/zenodo.1412597 # Version-independent DOI for the software archive
53+
title: 'Hypothesis: Property-Based Testing for Python'
54+
repository-code: https://github.com/HypothesisWorks/hypothesis
55+
license: MPL-2.0
56+
authors:
57+
- family-names: MacIver
58+
given-names: David R.
59+
orcid: https://orcid.org/0000-0002-8635-3223
60+
affiliation: Imperial College London
61+
- family-names: Hatfield-Dodds
62+
given-names: Zac
63+
orcid: https://orcid.org/0000-0002-8646-8362
64+
affiliation: Australian National University
65+
- name: "many other contributors"

‎hypothesis-python/docs/changes.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5773,7 +5773,7 @@ This is a no-op release, which implements automatic DOI minting and code
57735773
archival of Hypothesis via `Zenodo <https://zenodo.org/>`_. Thanks to
57745774
CERN and the EU *Horizon 2020* programme for providing this service!
57755775

5776-
Check our :gh-file:`CITATION` file for details, or head right on over to
5776+
Check our :gh-file:`CITATION.cff` file for details, or head right on over to
57775777
`doi.org/10.5281/zenodo.1412597 <https://doi.org/10.5281/zenodo.1412597>`_
57785778

57795779
.. _v3.71.3:

‎hypothesis-python/docs/community.rst‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,7 @@ Hypothesis related at all. If you post a question on Stack Overflow, please use
1616
Please note that `the Hypothesis code of conduct <https://github.com/HypothesisWorks/hypothesis/blob/master/CODE_OF_CONDUCT.rst>`_
1717
applies in all Hypothesis community spaces.
1818

19-
If you would like to cite Hypothesis, please consider `our suggested citation
20-
<https://github.com/HypothesisWorks/hypothesis/blob/master/CITATION>`_.
19+
If you would like to cite Hypothesis, please consider :gh-file:`our suggested citation <CITATION.cff>`.
2120

2221
If you like repo badges, we suggest the following badge, which you can add
2322
with reStructuredText or Markdown, respectively:

0 commit comments

Comments
 (0)