Skip to content

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

Merged

Conversation

Revathyvenugopal162
Copy link
Member

@Revathyvenugopal162 Revathyvenugopal162 commented Jul 13, 2024

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

  • arrange the gitignore
  • Add Forking the repository
  • Contributing via the GitHub website
  • Contributing locally on your computer
  • Submitting a pull request with your contribution

@Revathyvenugopal162 Revathyvenugopal162 marked this pull request as draft July 13, 2024 18:25
@Revathyvenugopal162 Revathyvenugopal162 marked this pull request as ready for review July 13, 2024 19:26
@flpm
Copy link
Member

flpm commented Jul 15, 2024

This is great @Revathyvenugopal162! Thanks for helping out!

@lwasser lwasser removed the scipy-24 label Jul 22, 2024
@willingc willingc requested review from lwasser and willingc August 1, 2024 16:48
Copy link
Collaborator

@willingc willingc left a 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.

Copy link
Member

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?

Copy link
Contributor

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!

Copy link
Member Author

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

@lwasser
Copy link
Member

lwasser commented Aug 1, 2024

@all-contributors please add @Revathyvenugopal162 for code, review

Copy link
Contributor

@lwasser

I've put up a pull request to add @Revathyvenugopal162! 🎉

@Revathyvenugopal162
Copy link
Member Author

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.

fixed the issue.

@willingc
Copy link
Collaborator

willingc commented Aug 5, 2024

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 🎉

@willingc willingc merged commit f1e511c into pyOpenSci:main Aug 5, 2024
3 of 4 checks passed
@tkoyama010
Copy link
Member

@all-contributors please add @Revathyvenugopal162 for doc

Copy link
Contributor

@tkoyama010

I've put up a pull request to add @Revathyvenugopal162! 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

Successfully merging this pull request may close these issues.

Update the Contributors Guide
6 participants