Skip to content

Commit 2af460e

Browse files
committed
Fixed test_bibtex unit test, updated CONTRIBUTING.md
1 parent c6b579d commit 2af460e

File tree

2 files changed

+8
-7
lines changed

2 files changed

+8
-7
lines changed

.github/CONTRIBUTING.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,13 @@ Additionally, if you are interesting in contributing to the codebase, submit a p
1616

1717
## How to contribute
1818

19-
1. Create a fork of `scholarly-python-package/scholarly` repository.
20-
2. If you add a new feature, try to include tests in already existing test cases, or create a new test case if that is not possible.
21-
3. Make sure the unit tests pass before raising a PR. For all the unit tests to pass, you typically need to setup a premium proxy service such as `ScraperAPI` or `Luminati` (`Bright Data`). If you do not have an account, you may try to use `FreeProxy`. Without a proxy, 6 out of 17 test cases will be skipped.
22-
4. Check that the documentatation is consistent with the code. Check that the documentation builds successfully.
23-
5. Submit a PR, with `develop` as your base branch.
24-
6. After an initial code review by the maintainers, the unit tests will be run with the `ScraperAPI` key stored in the Github repository. Passing all tests cases is necessary before merging your PR.
19+
1. Create a fork of `scholarly-python-package/scholarly` repository. Make sure that "Copy the main branch only" is **not** checked off.
20+
2. After cloning your fork and checking out into the develop branch, run `python setup.py --help-commands` for more info on how to install dependencies and build. You may need to run it with `sudo`.
21+
3. If you add a new feature, try to include tests in already existing test cases, or create a new test case if that is not possible. For a comprehensive output, run `python -m unittest -v test_module.py`
22+
4. Make sure the unit tests pass before raising a PR. For all the unit tests to pass, you typically need to setup a premium proxy service such as `ScraperAPI` or `Luminati` (`Bright Data`). By default, `python setup.py install` will get `FreeProxy`. Without a proxy, 6 out of 17 test cases will be skipped.
23+
5. Check that the documentatation is consistent with the code. Check that the documentation builds successfully.
24+
6. Submit a PR, with `develop` as your base branch.
25+
7. After an initial code review by the maintainers, the unit tests will be run with the `ScraperAPI` key stored in the Github repository. Passing all tests cases is necessary before merging your PR.
2526

2627

2728
## Build Docs

test_module.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -690,7 +690,7 @@ def test_bibtex(self):
690690
Test that we get the BiBTeX entry correctly
691691
"""
692692

693-
with open("testdata/bibtex.txt", "r") as f:
693+
with open("testdata/test_bibtex_result.txt", "r") as f:
694694
expected_result = "".join(f.readlines())
695695

696696
pub = scholarly.search_single_pub("A distribution-based clustering algorithm for mining in large "

0 commit comments

Comments
 (0)