You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+3-6Lines changed: 3 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,20 +22,19 @@ We review issues regularly and will respond as soon as possible.
22
22
If you would like to see support for a specific scholarly API, please open a GitHub issue describing:
23
23
24
24
- The name of the API
25
-
- A link to its official documentation
25
+
- A link to its official documentation and terms
26
26
- Why it would be useful for research or teaching
27
-
- Whether the API is open access or requires institutional credentials
28
27
29
28
### Submitting Code Contributions
30
29
31
30
Before submitting a pull request, please open an issue to discuss proposed changes. This helps ensure alignment with project goals and avoids duplicated work.
32
31
33
32
For tutorial contributions:
34
33
35
-
- Follow existing Python or R tutorial structure and formatting, particularly as it relates to licensing, external packages, and API authentication.
34
+
- Follow existing Python or R tutorial structure and formatting, particularly as it relates to documenting licensing, external packages, and API authentication details.
36
35
- Ensure all code runs without errors.
37
36
- Include clear explanations and comments.
38
-
-Avoid hard-coded credentials or private API keys.
37
+
-Do not hard code credentials or private API keys.
39
38
40
39
All contributions are reviewed for accuracy, clarity, reproducibility, and consistency with project standards.
41
40
@@ -53,8 +52,6 @@ The Scholarly API Cookbook is built using the following tools:
53
52
- The site is compiled using [Jupyter Book](https://jupyterbook.org/).
54
53
- An automated GitHub workflow builds the site and deploys it using [GitHub Actions](https://docs.github.com/en/actions).
55
54
56
-
Contributors should ensure that all notebooks and Markdown files build successfully before submitting changes.
57
-
58
55
## Questions
59
56
60
57
If you are unsure whether an idea fits the project scope, please open an issue to start a discussion.
0 commit comments