In preparation for #Hacktoberfest, I want to put together a post detailing how a new contributor could get involved with stumpy. This will be targeted to new open source contributors or python developers. It'll cover things like setting up a virtual environment, installing dependencies, git flow, tests, and CI/CD. In many ways, it extends CONTRIBUTING.md, but makes sure to cover the minutiae that a newcomer may trip on. The idea is to increase publicity and lower any barrier to entry for Hacktoberfest.
As I see it, there are three ways to do this:
- Extend CONTRIBUTING.md with this detailed post.
- Write the post in the documentation/tutorial section (Sphinx) and link to it in CONTRIBUTING.md.
- I host it on my own website.
I think the best solution is 2. It doesn't needlessly clutter CONTRIBUTING.md for more experienced contributors, but is available native to the rest of the stumpy content/documentation. Any thoughts or other recommendations (Medium/towards data science, etc)?
Ideally, I'd target a publication date between September 28th and October 2nd.
In preparation for #Hacktoberfest, I want to put together a post detailing how a new contributor could get involved with stumpy. This will be targeted to new open source contributors or python developers. It'll cover things like setting up a virtual environment, installing dependencies, git flow, tests, and CI/CD. In many ways, it extends CONTRIBUTING.md, but makes sure to cover the minutiae that a newcomer may trip on. The idea is to increase publicity and lower any barrier to entry for Hacktoberfest.
As I see it, there are three ways to do this:
I think the best solution is 2. It doesn't needlessly clutter CONTRIBUTING.md for more experienced contributors, but is available native to the rest of the stumpy content/documentation. Any thoughts or other recommendations (Medium/towards data science, etc)?
Ideally, I'd target a publication date between September 28th and October 2nd.