Skip to content

Commit c54fae0

Browse files
lwasserhugovk
andauthored
fix: edits from @hugovk
Co-authored-by: Hugo van Kemenade <[email protected]>
1 parent 7b872ba commit c54fae0

File tree

3 files changed

+7
-7
lines changed

3 files changed

+7
-7
lines changed

documentation/repository-files/contributing-file.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Including a well-written CONTRIBUTING.md file in your project is one way of maki
1919

2020
Make the guide welcoming. Use accessible language to encourage participation from contributors of all experience levels. For example:
2121

22-
- Avoid technical jargon or explain terms when necessary (e.g., "fork the repository").
22+
- Avoid technical jargon or explain terms when necessary (for example, "fork the repository").
2323
- Include a friendly introduction, such as "Thank you for your interest in contributing! We're excited to collaborate with you."
2424
- Highlight that all contributions, no matter how small, are valued.
2525

@@ -28,8 +28,8 @@ Make the guide welcoming. Use accessible language to encourage participation fro
2828
:::{admonition} Example contributing files
2929
:class: tip
3030

31-
- [pyGMT contributing file](https://github.com/GenericMappingTools/pygmt/blob/main/CONTRIBUTING.md)
32-
- [fatiando verde's contributing file](https://github.com/fatiando/verde/blob/main/CONTRIBUTING.md)
31+
- [PyGMT contributing file](https://github.com/GenericMappingTools/pygmt/blob/main/CONTRIBUTING.md)
32+
- [Verde's contributing file](https://github.com/fatiando/verde/blob/main/CONTRIBUTING.md)
3333
:::
3434

3535
Your Python package should include a file called **CONTRIBUTING.md** located in the
@@ -49,10 +49,10 @@ The CONTRIBUTING.md file should include information about:
4949
- Include instructions for the fork and pull request workflow, and link to resources or guides explaining these steps (if available).
5050
- Guidelines that you have in place for users submitting issues, pull requests or asking questions.
5151

52-
If you have a [development guide](development-guide), link to it. This guide should provide clear instructions on how to set up your development environment locally. It also should overview and CI tools that you have that could simplify the contribution process (e.g. pre-commit.ci bot, etc), linters, code formatters, etc.
52+
If you have a [development guide](development-guide), link to it. This guide should provide clear instructions on how to set up your development environment locally. It also should overview and CI tools that you have that could simplify the contribution process (for example, pre-commit.ci bot), linters, code formatters, and so on.
5353

5454
This guide should also include information for someone
55-
interested in asking questions. Some projects accept questions as GitHub or GitLab issues. Others use GitHub discussions, Discourse or even a discord server.
55+
interested in asking questions. Some projects accept questions as GitHub or GitLab issues. Others use GitHub discussions, Discourse or even a Discord server.
5656

5757
The contributing file should also include:
5858

documentation/repository-files/license-files.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ This would not be true with a GPL licensed package. `GPL-3` packages can include
130130

131131
## What about software citation?
132132

133-
While many permissive licenses do not require citation we STRONG encourage that you cite all software that you use in papers, blogs and other publications. You tell your users how to cite your package by using a [citation.cff file](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files). We will cover this topic when we talk about creating DOI's for your package using zenodo.
133+
While many permissive licenses do not require citation we STRONG encourage that you cite all software that you use in papers, blogs and other publications. You tell your users how to cite your package by using a [citation.cff file](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files). We will cover this topic when we talk about creating DOI's for your package using Zenodo.
134134

135135
<!-- TODO: add link when lesson is created - but also we don't yet know how citation.cff files work with Zenodo (do they work??) will the citation info update with a new Zenodo link
136136

documentation/repository-files/readme-file-best-practices.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The README.md file is the landing page of:
1414
Your README.md file is also used as a measure of package and community
1515
health on sites such as:
1616

17-
* [GitHub community health for MovingPandas (available for all repositories)](https://github.com/anitagraser/movingpandas/community) and [Snyk - moving pandas example](https://snyk.io/advisor/python/movingpandas)
17+
* [GitHub community health for MovingPandas (available for all repositories)](https://github.com/movingpandas/movingpandas/community) and [Snyk - MovingPandas example](https://snyk.io/advisor/python/movingpandas)
1818

1919
```{figure} /images/pandera-python-package-readme-github.png
2020
---

0 commit comments

Comments
 (0)