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.

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

Added an initial pass at a developer setup guide #210

Merged
merged 4 commits into from
Apr 11, 2024

Conversation

252afh
Copy link
Contributor

@252afh 252afh commented Apr 11, 2024

Context

We need a developer setup guide to help new joiners get set up with the project and learn how to run it locally.

Changes proposed in this pull request

Added a developer guide with the following sections:

  • Requirements
  • Installing packages
  • Setting environment variables
  • Building and running the project
  • How to run tests

Guidance to review

Run make docs-serve

DEVELOPER_SETUP.md Outdated Show resolved Hide resolved
DEVELOPER_SETUP.md Outdated Show resolved Hide resolved
DEVELOPER_SETUP.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@gecBurton gecBurton left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@252afh 252afh merged commit 1656750 into main Apr 11, 2024
7 checks passed
@252afh 252afh deleted the feature/add-developer-setup-guide branch April 11, 2024 12:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants