Skip to content

Commit 2fcae8e

Browse files
committed
docs: Clean up CONTRIBUTING.md
1 parent c496e53 commit 2fcae8e

1 file changed

Lines changed: 3 additions & 6 deletions

File tree

CONTRIBUTING.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,20 +22,19 @@ We review issues regularly and will respond as soon as possible.
2222
If you would like to see support for a specific scholarly API, please open a GitHub issue describing:
2323

2424
- The name of the API
25-
- A link to its official documentation
25+
- A link to its official documentation and terms
2626
- Why it would be useful for research or teaching
27-
- Whether the API is open access or requires institutional credentials
2827

2928
### Submitting Code Contributions
3029

3130
Before submitting a pull request, please open an issue to discuss proposed changes. This helps ensure alignment with project goals and avoids duplicated work.
3231

3332
For tutorial contributions:
3433

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.
3635
- Ensure all code runs without errors.
3736
- Include clear explanations and comments.
38-
- Avoid hard-coded credentials or private API keys.
37+
- Do not hard code credentials or private API keys.
3938

4039
All contributions are reviewed for accuracy, clarity, reproducibility, and consistency with project standards.
4140

@@ -53,8 +52,6 @@ The Scholarly API Cookbook is built using the following tools:
5352
- The site is compiled using [Jupyter Book](https://jupyterbook.org/).
5453
- An automated GitHub workflow builds the site and deploys it using [GitHub Actions](https://docs.github.com/en/actions).
5554

56-
Contributors should ensure that all notebooks and Markdown files build successfully before submitting changes.
57-
5855
## Questions
5956

6057
If you are unsure whether an idea fits the project scope, please open an issue to start a discussion.

0 commit comments

Comments
 (0)