-
Notifications
You must be signed in to change notification settings - Fork 72
docs: update the contribution guide #321
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: update the contribution guide #321
Conversation
This is great @Revathyvenugopal162! Thanks for helping out! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @Revathyvenugopal162. These are wonderful additions. ✨
We should troubleshoot why CI is failing. I may be able to do that next week. If you are able to do it, please feel free to do so.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I suspect this image might be the culprit. It looks like the extension is upper case rather than lower case! i am not sure if i can rename in this pr. but this line in the logs i think is the problem :) a quick fix that renames the image is welcome @Revathyvenugopal162 !
/home/runner/work/python-package-guide/python-package-guide/CONTRIBUTING.md:220: WARNING: image file not readable: images/contributing/pull-requests-tab.png
note: this is a guess - locally everything builds fine for me without error. but i wonder if this is a linux / ci issue?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Windows systems are case insensitive (regarding their file system) while Linux systems aren't. This is most probably the issue. Good catch @lwasser!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes, that was the issue and updated the image
@all-contributors please add @Revathyvenugopal162 for code, review |
I've put up a pull request to add @Revathyvenugopal162! 🎉 |
fixed the issue. |
Thanks @Revathyvenugopal162. The failing linkcheck is not due to this PR. I opened a PR #356 to address that link. After that PR run is green, I will loop back and merge this one. Congrats on your first contribution to pyOpenSci 🎉 |
@all-contributors please add @Revathyvenugopal162 for doc |
I've put up a pull request to add @Revathyvenugopal162! 🎉 |
partially fix #310
@lwasser and @flpm added the images related to contribution in a subfolder called contribution, just to avoid the cluttering of images in the same folder. please free to change the image/text