psf / python-in-edu

website for educational python resources
http://education.python.org/
MIT License
41 stars 28 forks source link

Add a CONTRIBUTING.md file and simplify README #46

Open birdcar opened 3 years ago

birdcar commented 3 years ago

Now that the requirements files are split up in #37 and the local dev environment has been simplified, we can now add a detailed and welcoming contribution guide.

This absorbs the install instructions from the README and expounds on the install and local development process so as to enable new developers to contribute to the project easly.

There were no guidelines in the README as far as commit hygene or other contribution guidelines, but it wouldn't be difficult to add later.

fixes: #19 fixes: #26 fixes: #27 relies on: #38

birdcar commented 3 years ago

@meg-ray This should be good to go 👍🏽

Because the project is part of mentored-sprints, I took stock of the technical ability of those I had been working with as a mentor and wrote the contributing guidelines with the lowest barrier to entry I could. The result is a bit exhaustive, but I felt like it was a good way to ensure that the project could support newcomers in future mentored sprints (should that be a goal of the repository).

Let me know if you want it tightened up and I'll definitely rewrite it to be less verbose. 🙇🏽