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

Debugging setup of VS Code section update #3181

Merged
merged 4 commits into from
Oct 24, 2023
Merged

Debugging setup of VS Code section update #3181

merged 4 commits into from
Oct 24, 2023

Conversation

mustious
Copy link
Contributor

Signed-off-by: Mustapha Abdullahi [email protected]

Description

The earlier documentation will give some users difficulty in setting up VS Code debugging with Kedro as there has been changes in VS Code UI. This PR provides a more descriptive guide to the users in setting up debugging. Following this commit (focused on the debugging), more updates will be made on the overall Kedro with VS Code setup documentation to reflect changes of VS Code UI.

Development notes

Only documentation markdown changed.

Developer Certificate of Origin

We need all contributions to comply with the Developer Certificate of Origin (DCO). All commits must be signed off by including a Signed-off-by line in the commit message. See our wiki for guidance.

If your PR is blocked due to unsigned commits, then you must follow the instructions under "Rebase the branch" on the GitHub Checks page for your PR. This will retroactively add the sign-off to all unsigned commits and allow the DCO check to pass.

Checklist

  • Read the contributing guidelines
  • Signed off each commit with a Developer Certificate of Origin (DCO)
  • Opened this PR as a 'Draft Pull Request' if it is work-in-progress
  • Updated the documentation to reflect the code changes
  • Added a description of this change in the RELEASE.md file
  • Added tests to cover my changes
  • Checked if this change will affect Kedro-Viz, and if so, communicated that with the Viz team

@astrojuanlu
Copy link
Member

Copy link
Member

@astrojuanlu astrojuanlu 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 your PR @mustious! I left a comment

docs/source/development/set_up_vscode.md Outdated Show resolved Hide resolved
Copy link
Member

@astrojuanlu astrojuanlu left a comment

Choose a reason for hiding this comment

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

Instructions look OK to me! Paging @stichbury for the final review

docs/source/development/set_up_vscode.md Outdated Show resolved Hide resolved
@astrojuanlu
Copy link
Member

The DCO bot is failing because commit authorship email does not match signoff email, @mustious do you mind having a look at that? You did right by signing off the commits with -s, but I think you have your personal email configured globally for git (you can check by doing git config --get-all user.email).

@mustious
Copy link
Contributor Author

The DCO bot is failing because commit authorship email does not match signoff email, @mustious do you mind having a look at that? You did right by signing off the commits with -s, but I think you have your personal email configured globally for git (you can check by doing git config --get-all user.email).

Yes very true. I was using a QB email in my git and a personal email in signing-off. I will make the necessary changes. Thank you @astrojuanlu

Copy link
Contributor

@stichbury stichbury left a comment

Choose a reason for hiding this comment

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

Requested changes noted in comment on the file

Copy link
Contributor

@stichbury stichbury left a comment

Choose a reason for hiding this comment

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

LGTM thanks @mustious ! 🌟

@astrojuanlu
Copy link
Member

(I'm meeting with @mustious next week to see if we can understand what's going on with the signoff 😄)

Signed-off-by: Mustapha Abdullahi <[email protected]>
Signed-off-by: Mustapha Abdullahi <[email protected]>
@astrojuanlu astrojuanlu enabled auto-merge (squash) October 23, 2023 11:17
@mustious
Copy link
Contributor Author

(I'm meeting with @mustious next week to see if we can understand what's going on with the signoff 😄)

Thanks so much @astrojuanlu for your assistance 🚀🎉

@astrojuanlu
Copy link
Member

RTD problem is unrelated:

sphinx.errors.SphinxWarning: /home/docs/checkouts/readthedocs.org/user_builds/kedro/checkouts/3181/docs/source/nodes_and_pipelines/pipeline_registry.md:34:broken link: https://github.com/kedro-org/kedro-starters/blob/main/spaceflights/%7B%7B%20cookiecutter.repo_name%20%7D%7D/src/%7B%7B%20cookiecutter.python_package%20%7D%7D/pipeline_registry.py (404 Client Error: Not Found for url: https://github.com/kedro-org/kedro-starters/blob/main/spaceflights/%7B%7B%20cookiecutter.repo_name%20%7D%7D/src/%7B%7B%20cookiecutter.python_package%20%7D%7D/pipeline_registry.py)

We will fix it separately

mustious and others added 2 commits October 24, 2023 11:48
Signed-off-by: Mustapha Abdullahi <[email protected]>
Signed-off-by: Juan Luis Cano Rodríguez <[email protected]>
@astrojuanlu astrojuanlu merged commit 364917c into kedro-org:main Oct 24, 2023
12 of 16 checks passed
adamkells pushed a commit to adamkells/kedro that referenced this pull request Oct 30, 2023
Signed-off-by: Mustapha Abdullahi <[email protected]>
Signed-off-by: Mustapha Abdullahi <[email protected]>
Signed-off-by: Adam Kells <[email protected]>
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.

3 participants