View this content as hosted on Python Like You Mean It
This repository contains the source material for the website Python Like You Mean It. The site is written primarily in Jupyter notebooks (which are transformed into html using nbsphinx). A huge perk of this of this is that you simply need to be familiar with Jupyter notebooks and some markdown syntax in order to contribute to this project!
Please feel free to post questions (or point out mistakes) about the reading by opening a GitHub issue. Someone from the PLYMI team will respond ASAP! Refer to this reference to see how to include python-codeblocks in your post. This will make it much easier for us to discuss code with each other.
Contributions to this project are very welcome! I will be sure to credit any/all contributions (unless your want to remain anonymous). Some great ways to help out are to:
- proofread
- add reading comprehension exercises to existing sections
- provide general feedback about the organization of the website, the consistency of the material, etc.
- create lengthier standalone problems to serve as holistic examples of how to apply the concepts presented in the reading
- recommend new sections to be added to PLYMI
You can either open an issue to provide feedback or point out errors, or you can create a pull request) if you want to submit new/modified materials. The other maintainers of PLYMI and I are happy to help you refine your issues and PRs, so please do not be discouraged if you are new to Git/GitHub.
I have posted a number of "To-Do" tasks in this project's issues page, and I will be adding to these as this project progresses. Included are requests for proofreading and exercises. Please post within an issue if you are working on a to-do item, so multiple people don't end up working on the same task. General feedback on content is also hugely valuable, so feel free to open a new issue to provide your feedback on any of the material.
Here is a nice Markdown "cheat sheet" for looking up how to make tables, code-blocks, etc., in Markdown.
If you want to submit a change to some of the content (e.g. correcting typos), do the following:
- Clone this repository
- Create a new branch, appropriately named for whatever task you are performing:
git checkout -b your_branch_name - Check out your new branch and commit any changes you make to it
- Push your branch:
git push origin your_branch_name(you should have permission to do this, if you are added as a "contributor" to this project) - Create a Pull Request) from your branch into the master branch.