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

docs: developer setup instructions to run codebase #385

Merged
merged 4 commits into from
Sep 27, 2024
Merged

docs: developer setup instructions to run codebase #385

merged 4 commits into from
Sep 27, 2024

Conversation

andimiya
Copy link
Contributor

Pull Request

Add documentation for developers on how to set up this codebase to run locally

Proposed Changes

Add instructions to README on how to get started running the codebase if contributing.
Closes: #384

Readiness Checklist

Author/Contributor

  • If documentation is needed for this change, has that been included in this pull request
  • run make lint and fix any issues that you have introduced
  • run make test and ensure you have test coverage for the lines you are introducing
  • If publishing new data to the public (scorecards, security scan results, code quality results, live dashboards, etc.), please request review from @jeffrey-luszcz

Reviewer

  • Label as either fix, documentation, enhancement, infrastructure, maintenance, or breaking

@andimiya andimiya added the documentation Improvements or additions to documentation label Sep 27, 2024
@andimiya andimiya self-assigned this Sep 27, 2024
@andimiya andimiya mentioned this pull request Sep 27, 2024
Closed
@jmeridth
Copy link
Member

Failing check is unrelated to this PR's changes. Approving but hopefully the 401 will self resolve soon.

zkoppert
zkoppert approved these changes Sep 27, 2024
View reviewed changes
Copy link
Member

@zkoppert zkoppert left a comment

Choose a reason for hiding this comment

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

Awesome! Thanks for contributing and making this project easier to use!

@andimiya andimiya merged commit 3763b2f into main Sep 27, 2024
31 checks passed
@andimiya andimiya deleted the andimiya/384/dev_setup_instructions branch September 27, 2024 23:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jmeridth jmeridth jmeridth approved these changes

@zkoppert zkoppert zkoppert approved these changes

@sutterj sutterj sutterj approved these changes

Assignees

@andimiya andimiya

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

Successfully merging this pull request may close these issues.

Developer setup instructions to run this repo's code
4 participants
@andimiya @jmeridth @zkoppert @sutterj