Add a CONTRIBUTING.md file and simplify README #46
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Now that the requirements files are split up in psf#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: psf#19, psf#26, psf#27 relies on: psf#37
|
@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. 🙇🏽 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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