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
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:
49
49
- Include instructions for the fork and pull request workflow, and link to resources or guides explaining these steps (if available).
50
50
- Guidelines that you have in place for users submitting issues, pull requests or asking questions.
51
51
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.
53
53
54
54
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.
Copy file name to clipboardExpand all lines: documentation/repository-files/license-files.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -130,7 +130,7 @@ This would not be true with a GPL licensed package. `GPL-3` packages can include
130
130
131
131
## What about software citation?
132
132
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.
134
134
135
135
<!-- 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
Copy file name to clipboardExpand all lines: documentation/repository-files/readme-file-best-practices.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@ The README.md file is the landing page of:
14
14
Your README.md file is also used as a measure of package and community
15
15
health on sites such as:
16
16
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)
0 commit comments