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 the project template README.md #3387

Merged
merged 2 commits into from
Dec 5, 2023
Merged

Conversation

ankatiyar
Copy link
Contributor

NOTE: Kedro datasets are moving from kedro.extras.datasets to a separate kedro-datasets package in
kedro-plugins repository. Any changes to the dataset implementations
should be done by opening a pull request in that repository.

Description

Fix #2305

Development notes

Updated the project's README.
It was already mostly up-to-date on the develop branch except for the changes I made.

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: Ankita Katiyar <[email protected]>
Signed-off-by: Ankita Katiyar <[email protected]>
@ankatiyar ankatiyar requested a review from merelcht as a code owner December 4, 2023 15:18
@ankatiyar ankatiyar self-assigned this Dec 4, 2023
@ankatiyar
Copy link
Contributor Author

@AhdraMeraliQB @SajidAlamQB @merelcht What do you think about the other thing mentioned in the issue - wrt adding a README.md to the template's docs/source folder? In the context of #3376, I didn't write a guide yet if there's still changes to be made and will need to be updated in two places (docs and the Readme file).

Copy link
Member

@merelcht merelcht left a comment

Choose a reason for hiding this comment

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

LGTM! 👍

wrt adding a README.md to the template's docs/source folder?

I'd leave this for now, because of the issue you mentioned but also because it would again at files to the template which might not be necessary if the docs are clear enough.

@ankatiyar ankatiyar merged commit 7e99fb2 into develop Dec 5, 2023
9 checks passed
@ankatiyar ankatiyar deleted the docs/update-template-readme branch December 5, 2023 09:59
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