Skip to content

Commit 4a292cf

Browse files
authored
Update CONTRIBUTING.md
1 parent 627be82 commit 4a292cf

File tree

1 file changed

+8
-48
lines changed

1 file changed

+8
-48
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -7,47 +7,6 @@ You can contribute in many ways:
77

88
## Types of Contributions
99

10-
### Report duplicate error (FP or FN)
11-
12-
Provide the case in the following format, allowing us to add it to the `tests/test_cases.json`:
13-
14-
```json
15-
{
16-
"id": "abrahao_parigi_gupta_cook_2017_pnas_short_vs_full",
17-
"note": "Same paper; record_b uses abbreviated author formatting and omits venue fields; record_a includes DOI.",
18-
19-
"record_a": {
20-
"ENTRYTYPE": "article",
21-
"ID": "1",
22-
"doi": "10.1073/PNAS.1604234114",
23-
"author": "Abrahao, Bruno and Parigi, Paolo and Gupta, Alok and Cook, Karen S.",
24-
"title": "Reputation offsets trust judgments based on social biases among Airbnb users",
25-
"journal": "Proceedings of the National Academy of Sciences",
26-
"number": "37",
27-
"pages": "9848--9853",
28-
"volume": "114",
29-
"year": "2017"
30-
},
31-
"record_b": {
32-
"ENTRYTYPE": "article",
33-
"ID": "2",
34-
"author": "B. Abrahao; P. Parigi; A. Gupta; K. S. Cook",
35-
"year": "2017",
36-
"title": "Reputation offsets trust judgments based on social biases among Airbnb users"
37-
},
38-
39-
"expected_duplicate": true
40-
}
41-
```
42-
43-
### Fixing duplicate errors
44-
45-
All changes to deduplication logic (`prep`, `sim`, `match`) should be accompanied with a test case in the pull request.
46-
47-
TODO:
48-
- before merging, the ldd-full tests should be run to determine how the changes affect overall performance. (TBD: locally? how will it be triggered? how do we ensure that the right version/branch is tested? How are results added in the pull request? Do we want to consider performance implications?)
49-
- consider possiblity of schema inconsistency
50-
5110
### Report Bugs
5211

5312
Report bugs at https://github.com/CoLRev-Environment/bib-dedupe/issues.
@@ -92,13 +51,13 @@ Ready to contribute? Here's how to set up BibDedupe for local development.
9251
1. Fork the `bib-dedupe` repo on GitHub.
9352
2. Clone your fork locally:
9453

95-
```sh
54+
```
9655
git clone git@github.com:your_name_here/bib-dedupe.git
9756
```
9857
9958
3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:
10059
101-
```sh
60+
```
10261
mkvirtualenv bib-dedupe
10362
cd bib-dedupe/
10463
pip3 install poetry
@@ -107,7 +66,7 @@ Ready to contribute? Here's how to set up BibDedupe for local development.
10766
10867
4. Create a branch for local development:
10968
110-
```sh
69+
```
11170
git checkout -b name-of-your-bugfix-or-feature
11271
```
11372
@@ -116,14 +75,14 @@ Ready to contribute? Here's how to set up BibDedupe for local development.
11675
5. When you're done making changes, check that your changes pass the
11776
tests and pre-commit hooks:
11877
119-
```sh
78+
```
12079
pytest
12180
pre-commit run -a
12281
```
12382
12483
6. Commit your changes and push your branch to GitHub:
12584
126-
```sh
85+
```
12786
git add .
12887
git commit -m "Your detailed description of your changes."
12988
git push origin name-of-your-bugfix-or-feature
@@ -139,8 +98,9 @@ Before you submit a pull request, check that it meets these guidelines:
13998
2. If the pull request adds functionality, the docs should be updated. Put
14099
your new functionality into a function with a docstring, and add the
141100
feature to the list in README.rst.
142-
3. The pull request should work for the Python versions specified in the `pyproject.toml`.
143-
Make sure that the tests pass for all supported Python versions.
101+
3. The pull request should work for Python 3.5, 3.6, 3.7 and 3.8, and for PyPy. Check
102+
https://travis-ci.com/CoLRev-Ecosystem/bib-dedupe/pull_requests
103+
and make sure that the tests pass for all supported Python versions.
144104
145105
## Coding standards
146106

0 commit comments

Comments
 (0)