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

minor tech debts #3533

Closed
wants to merge 1 commit into from
Closed

minor tech debts #3533

wants to merge 1 commit into from

Conversation

DimedS
Copy link
Contributor

@DimedS DimedS commented Jan 19, 2024

Description

Last issues from #3264 :

  1. It appears that all file and directory operations are encapsulated within try-except blocks. @SajidAlamQB, have you identified any cases that are not covered?

  2. The issue has been addressed in Change to short names in config #3499. A default values section was introduced for tools and the example_pipeline. Here, I have inserted a comment in that section stating that the default value for the project name will be sourced from the cookiecutter.json file located in the project's directory.

  3. The possibility of integrating flag_inputs into the _get_extra_context() function exists, but such a change would require code modifications. I am not convinced that this alteration would simplify the maintenance of _get_extra_context(). Therefore, I suggest keeping it as is for now.

Development notes

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: Dmitry Sorokin <dmd40in@gmail.com>
@DimedS DimedS linked an issue Jan 19, 2024 that may be closed by this pull request
12 tasks
@DimedS DimedS marked this pull request as ready for review January 19, 2024 16:35
@SajidAlamQB
Copy link
Contributor

  1. It appears that all file and directory operations are encapsulated within try-except blocks.

In that case no worries, happy to proceed. Thank you @DimedS.

@AhdraMeraliQB
Copy link
Contributor

AhdraMeraliQB commented Jan 24, 2024

Closing after brief discussion. It was agreed that there wasn't much to gain from adding this comment - instead we should concentrate explanation efforts in developer docs. Xref similar decision.

@merelcht merelcht deleted the minor-tech-debts-kedro-new branch February 2, 2024 11:49
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.

Minor tech debts in the project creation flow
4 participants