Skip to content

Write a README with local dev setup instructions #2

Description

@avenmia

This should update the README.md file to have instructions for a person setting up the project for the first time. Add step by step instructions starting with what dependencies are needed, and steps to get the website running.

Also add a How To Contribute section, something along these lines:
git clone
git switch -c "Your-Branch-Name"
// Work on your changes
git add ChangedFile1, ChangedFile2,...
git commit -m "Your change message"
git push -u origin Your-Branch-Name
Once changes are done, in GitHub open a PR
Add a note about which issue is being solved
Assign a reviewer

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions