feat(contrib file): update to contributing and links to other resources #440
Conversation
| - 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.
| 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. |
lwasser
changed the title
|
Thank you everyone! i've incorporated all of the feedback and will merge this once CI is happy 🚀 |
Co-authored-by: Hugo van Kemenade <[email protected]>
Co-authored-by: Jeremiah Paige <[email protected]>
lwasser
force-pushed
the
contributing
branch
from
13292c9 to
6425748
Compare
|
@hugovk, may I add you to our GitHub "packaging council" GitHub team here so you can approve PR's? |
|
The link failures here are unrelated to this PR. it could be because there have been some changes to the GitHub UI in the past weeks. I am going to merge for now. |
|
Yeah, we've skipped checking GitHub anchors in other projects. (Sphinx, but for example: https://github.com/python/devguide/blob/b28d4de4d7bc79c199acdf3dfc19bd0dd0ff22fe/conf.py#L87-L92) Also https://github.com/pyOpenSci/pyosMeta/blob/main/pyproject.toml#L60 is now currently pointing to an empty line. You can choose the correct line and select "Copy permalink" to get something more durable: 
And the "Y" key is a shortcut for that, it'll replace |
|
oh wow - thanks. I didn't know about that! I don't want to ping her here, but I think Carol W set up something like that in one of our repos. i'll look into it. Thank you Hugo!! |
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!