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

Update Contributing.md Guide #3247

Closed
dawoodkhan82 opened this issue Feb 20, 2023 · 3 comments · Fixed by #5799
Closed

Update Contributing.md Guide #3247

dawoodkhan82 opened this issue Feb 20, 2023 · 3 comments · Fixed by #5799
Assignees
Labels
docs/website Related to documentation or website

Comments

@dawoodkhan82
Copy link
Collaborator

dawoodkhan82 commented Feb 20, 2023

Provide more details and steps for setting up local dev environment and start running/debugging a demo.

@dawoodkhan82 dawoodkhan82 self-assigned this Feb 20, 2023
@abidlabs
Copy link
Member

It seems a lot of people also get stuck when using Codespaces so it'd be nice to make sure that DX flow is streamlined. Related issue: #2343

@abidlabs abidlabs added the docs/website Related to documentation or website label Feb 20, 2023
@abidlabs
Copy link
Member

abidlabs commented Mar 7, 2023

A few other things I noticed @dawoodkhan82:

  • we no longer use CircleCI so this should be removed from contributing.md
  • we have added a linter but this is not mentioned in contributing.md

Also the PR template is a little bloated, perhaps we can trim that a bit as well

@thepelkus-too
Copy link

A note on testing in that document:

Under Continuous Integration and Testing it says:

All PRs must pass the continuous integration tests before merging. To test locally, you can run python -m unittest from the repo directory.

When I ran that command, no tests were run. However, when I ran the test command from the Extra tidbits:

bash scripts/run_all_tests.sh

it seemed like it might've been doing what I would expect.

I had some difficulties with those tests that might've stemmed from running in the Windows Subsystem for Linux, but I'm not sure just yet; I'll make another note here if I can pin that down.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs/website Related to documentation or website
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants