Contributing Overview

A comprehensive and accessible coding bilingualism website like this one is a huge undertaking and I’d welcome collaborators who share my vision for the value of a resource like this. I’m a competent R coder but that definitely does not mean I am 100% correct all the time nor that I always write explanations in the clearest way possible. On the Python front, my first real foray into that coding language is taking tutorials and making this website.

So, if you’d like to collaborate with me on this I have drafted the following guidelines. I’m happy to discuss/modify these with prospective collaborators so please don’t let them dissuade you from reaching out!

Bug / Issue Reporting

If you see something wrong–either in a code chunk or in the plain text–I’d really appreciate it if you flagged it for my attention. You can do this by opening a GitHub Issue on this project’s repository. Please include the link to the page with the problem and as much detail as possible so I can easily find the problem area and make any needed repairs.

If you identify a bug in this manner I’ll add your name (and the link to the professional website of your choosing) to the list below!

Bug Finders

Co-Development

If you’d like to actively collaborate with me on developing and refining this website that would be awesome! Please either reach out to me directly (see my website for my contact info) or open a GitHub Issue to get that conversation started.

I’m envisioning that each new collaborator would (1) fork the website’s GitHub repository, (2) make any edits that they had in mind, and (3) then submit a pull request to get those changes integrated into the primary website. I feel this minimizes the risk that changes have unintentional consequences for the website rendering as whole. I’m absolutely open to a branch-based alternative if that makes more sense and I anticipate refining the logistical elements of contributing once the development team grows somewhat.

Contribution Credit

If you are interested/willing to join me in refining this website, I believe that is absolutely worthy of formal credit. You’ll notice that the top right of the navbar has a “Creators” dropdown menu. If you contribute substantively (e.g., demonstrating new tools, adding a new page, etc.) we can add your name to the dropdown and link it to the professional website of your choosing.

If you have other modes of properly acknowledging your contribution(s) in mind I am absolutely open to discussing those ideas!