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

Update CONTRIBUTING.md to help contributors get started #32

Open
SerpentBytes opened this issue Dec 7, 2022 · 1 comment
Open

Update CONTRIBUTING.md to help contributors get started #32

SerpentBytes opened this issue Dec 7, 2022 · 1 comment
Assignees
@rudychung
Labels
🗒️ documentation Improvements or additions to documentation

Comments

@SerpentBytes
Copy link
Collaborator

Description

Currently, the CONTRIBUTING.md file is missing information on how to run the project in the development environment. The current steps are not very helpful to new contributors.

Some helpful information:

  • Pre-requisites to running the project
  • How to run the frontend
  • How to run different workers
  • How to Contribute, etc.
@SerpentBytes SerpentBytes added the 🗒️ documentation Improvements or additions to documentation label Dec 7, 2022
@rudychung
Copy link
Contributor

Hey, could I work on this one? I'm not 100% sure on how the workers work, but everything else I should be able to write on.

@rudychung rudychung mentioned this issue Dec 10, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@rudychung rudychung

Labels
🗒️ documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@SerpentBytes @rudychung