pyatl/podium-django

Docs: Create a more explicit beginner's references for new contributors

Closed this issue · 0 comments

The CONTRIBUTING guide provides overall guidelines for newcomers to the project who want to contribute changes or fix issues. However, it doesn't provide enough detail and explicit instructions pertaining to this particular project to make it completely approachable to novices, especially those newer to contributing to projects and using the appropriate tools (git, Github features, linters, etc).

In addition, beginners can't usually be expected to click through a long list of links to random blog articles and best practices documents and pull all the information together and interpret and modify it correctly in order to produce well-formed commits and pull requests.

Provide a beginner's guide that steps newcomers through the complete process of forking the repo, cloning, branching, making commits, and creating a pull request, all in a single document with the goal that ANYONE could follow it to produce their first pull request for at least a simple code or documentation change.