antonio-hickey / antonio-hickey/Relay

Create guide for contributors

Open
#16 0 comments 0 reactions 1 assignee Claimed by @antonio-hickey View on GitHub
documentation
Dominant language
Python
Stars
1
Forks
0
PR merge metrics
No merged PRs in 30d

Description

Write documentation on how to set up an environment for people looking to contribute to the project. We should assume the person looking to contribute doesn't have python or git installed and will guide them as if they just got a fresh computer with nothing installed.

Topics to cover
- Installing python 3.10
- Installing git
- Basic use of git
- Set up virtual environment for Relay repo
- Set up pre-commit
- Running the app
- Using / Testing the app

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.