Skip to content

docs: Add setup instructions to run/debug tests locally #153

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

Merged
merged 4 commits into from
Aug 13, 2021

Conversation

ca-nguyen
Copy link
Contributor

@ca-nguyen ca-nguyen commented Jul 16, 2021

Description of changes:
Added instructions to set up PyCharm for running and debugging tests locally.


By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

CONTRIBUTING.md Outdated
Comment on lines 173 to 175
## Setting Up Your Development Environment

Setting up your IDE for debugging your tests locally will save you a lot of time.
Copy link
Contributor

Choose a reason for hiding this comment

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

please include a note with the version that these instructions apply to / were tested on.

Copy link
Contributor

Choose a reason for hiding this comment

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

Version of the data science SDK? Like 2.2.0? They should apply to all versions

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Were you referring to the PyCharm versions @shivlaks? We tested it on 2 different PyCharm versions, I can definitely add the info here.

Copy link
Contributor

Choose a reason for hiding this comment

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

I meant the PyCharm version

Copy link
Contributor

Choose a reason for hiding this comment

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

I meant the PyCharm version

Ah - makes sense

@shivlaks shivlaks changed the title documentation: Add setup instructions to run/debug tests locally docs: Add setup instructions to run/debug tests locally Jul 19, 2021
Copy link
Contributor

@shivlaks shivlaks left a comment

Choose a reason for hiding this comment

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

thanks for turning around the feedback. got a couple minor nits but otherwise looks good.

@ca-nguyen ca-nguyen requested a review from shivlaks August 12, 2021 00:59
@StepFunctions-Bot
Copy link
Contributor

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildProject6AEA49D1-sEHrOdk7acJc
  • Commit ID: 6b6443a
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

Copy link
Contributor

@shivlaks shivlaks left a comment

Choose a reason for hiding this comment

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

LGTM 🎉

Copy link
Contributor

@wong-a wong-a left a comment

Choose a reason for hiding this comment

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

Thanks for adding these instructions! This should help new contributors get started 👍

@ca-nguyen ca-nguyen merged commit 6b62bf7 into aws:main Aug 13, 2021
@ca-nguyen ca-nguyen deleted the update-contributing branch October 27, 2021 01:12
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.

4 participants