[feb 3 merge] feat(contrib file): update to contributing and links to other resources #440
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ucodery
approved these changes
Jan 21, 2025
| - Include instructions for the fork and pull request workflow, and link to resources or guides explaining these steps (if available). | ||
| - Guidelines that you have in place for users submitting issues, pull requests or asking questions. | ||
|
|
||
| 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. |
There was a problem hiding this comment.
Suggested change
| 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. | |
| 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 local and CI tools that you have that could simplify the contribution process (e.g. pre-commit.ci bot, etc), linters, code formatters, etc. |
|
|
||
| - The types of contributions that you welcome | ||
|
|
||
| > Example: We welcome contributions of all kinds. If you want to address an existing issue, check out our issues in this repository and comment on the one that you'd like to open to. Otherwise, you can open a new issue... |
There was a problem hiding this comment.
Suggested change
| > Example: We welcome contributions of all kinds. If you want to address an existing issue, check out our issues in this repository and comment on the one that you'd like to open to. Otherwise, you can open a new issue... | |
| > Example: We welcome contributions of all kinds. If you want to address an existing issue, check out our issues in this repository and comment on the one that you'd like to help with. Otherwise, you can open a new issue... |
hugovk
reviewed
Jan 22, 2025
|
|
||
| Make the guide welcoming. Use accessible language to encourage participation from contributors of all experience levels. For example: | ||
|
|
||
| - Avoid technical jargon or explain terms when necessary (e.g., "fork the repository"). |
There was a problem hiding this comment.
We also avoid Latin abbreviations over in CPython (and by many other style guides), "e.g." and "i.e." are often mixed up.
Suggested change
| - Avoid technical jargon or explain terms when necessary (e.g., "fork the repository"). | |
| - Avoid technical jargon or explain terms when necessary (for example, "fork the repository"). |
| - Include instructions for the fork and pull request workflow, and link to resources or guides explaining these steps (if available). | ||
| - Guidelines that you have in place for users submitting issues, pull requests or asking questions. | ||
|
|
||
| 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. |
There was a problem hiding this comment.
Suggested change
| 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. | |
| 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. |
Comment on lines
+31
to
+32
| - [pyGMT contributing file](https://github.com/GenericMappingTools/pygmt/blob/main/CONTRIBUTING.md) | ||
| - [fatiando verde's contributing file](https://github.com/fatiando/verde/blob/main/CONTRIBUTING.md) |
There was a problem hiding this comment.
Use project's own spelling:
Suggested change
| - [pyGMT contributing file](https://github.com/GenericMappingTools/pygmt/blob/main/CONTRIBUTING.md) | |
| - [fatiando verde's contributing file](https://github.com/fatiando/verde/blob/main/CONTRIBUTING.md) | |
| - [PyGMT contributing file](https://github.com/GenericMappingTools/pygmt/blob/main/CONTRIBUTING.md) | |
| - [Verde's contributing file](https://github.com/fatiando/verde/blob/main/CONTRIBUTING.md) |
|
|
||
| This guide should also include information for someone | ||
| interested in asking questions, submitting issues or pull requests. It should have things like: | ||
| interested in asking questions. Some projects accept questions as GitHub or GitLab issues. Others use GitHub discussions, Discourse or even a discord server. |
There was a problem hiding this comment.
Suggested change
| interested in asking questions. Some projects accept questions as GitHub or GitLab issues. Others use GitHub discussions, Discourse or even a discord server. | |
| interested in asking questions. Some projects accept questions as GitHub or GitLab issues. Others use GitHub discussions, Discourse or even a Discord server. |
| @@ -128,16 +128,14 @@ This would not be true with a GPL licensed package. `GPL-3` packages can include | |||
| 🚨 Proceed with caution! 🚨 | |||
| ::: | |||
|
|
|||
|
|
|||
| ## What about software citation? | |||
| ## What about software citation? | |||
|
|
|||
| 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. | |||
There was a problem hiding this comment.
Suggested change
| 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. | |
| 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. |
|
|
||
| * [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) |
There was a problem hiding this comment.
Suggested change
| * [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) | |
| * [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) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR makes the contributing file more engaging and descriptive. it highlights this file as being a "Welcome mat" of sorts that invites contributors in and guides them through the process.
Let's try to merge this by Feb 3!! All feedback is welcome!