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 docs on installing development requirements #4178

Merged
merged 8 commits into from
Sep 23, 2024

Conversation

ElenaKhaustova
Copy link
Contributor

Description

Solves #2519

Docs update following the kedro-org/kedro-starters#238

Development notes

We updated docs in the development section related to linting and test requirements installation.

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

Signed-off-by: Elena Khaustova <[email protected]>
Signed-off-by: Elena Khaustova <[email protected]>
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.

I like how these docs look like! But wondering if we should also update the template

pytest-cov~=3.0
pytest-mock>=1.7.1, <2.0
pytest~=7.2
ruff~=0.1.8

otherwise our docs and the result of kedro new would be somewhat inconsistent

Copy link
Contributor

@ankatiyar ankatiyar left a comment

Choose a reason for hiding this comment

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

💯

@ElenaKhaustova ElenaKhaustova marked this pull request as draft September 23, 2024 09:30
@ElenaKhaustova ElenaKhaustova self-assigned this Sep 23, 2024
@ElenaKhaustova ElenaKhaustova marked this pull request as ready for review September 23, 2024 10:14
@ElenaKhaustova
Copy link
Contributor Author

@ankatiyar, @astrojuanlu thank you for the review!

I've added some updates after your approval as e2e and unit tests were failing. In the tests we relied on the old format of requirements.txt for kedro project which included development requirements. We also use a separate starter template for e2e tests which I had to update: https://github.com/kedro-org/kedro/tree/main/features/steps/test_starter

Could you please take a brief look one more time?

Also, I found using a separate starter for e2e test a bit counterintuitive as I expected the default starter from the project to be used. What do you think of updating e2e test and copying the default starter instead of keeping separate one?

Copy link
Contributor

@ankatiyar ankatiyar 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 also fixing the tests @ElenaKhaustova!

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.

LGTM!

@ElenaKhaustova ElenaKhaustova merged commit 86f9304 into main Sep 23, 2024
41 checks passed
@ElenaKhaustova ElenaKhaustova deleted the docs/2519-dev-requirements branch September 23, 2024 11:29
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.

ci: Nightly build failure on develop ci: Nightly build failure on main
3 participants