Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add a CONTRIBUTING.md file and simplify README #46

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Add a CONTRIBUTING.md file and simplify README #46

wants to merge 4 commits into from

Commits on May 16, 2021

  1. Add a CONTRIBUTING.md file and simplify README 

    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
    @birdcar
    birdcar committed May 16, 2021
    Configuration menu
    Copy the full SHA
    fb75ddd View commit details
    Browse the repository at this point in the history

  2. Ensure the imperitive voice is consistently used in CONTRIBUTING.md

    @birdcar
    birdcar committed May 16, 2021
    Configuration menu
    Copy the full SHA
    e7611e1 View commit details
    Browse the repository at this point in the history

  3. Fix markdown linter warnings

    @birdcar
    birdcar committed May 16, 2021
    Configuration menu
    Copy the full SHA
    12fbb9f View commit details
    Browse the repository at this point in the history

  4. Clarify the prose after proofreading the document

    @birdcar
    birdcar committed May 16, 2021
    Configuration menu
    Copy the full SHA
    2fa776e View commit details
    Browse the repository at this point in the history