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

[Docs] Quick flow of steps for first-time developers to Kedro #256

Closed
neomatrix369 opened this issue Feb 26, 2020 · 1 comment
Closed

[Docs] Quick flow of steps for first-time developers to Kedro #256

neomatrix369 opened this issue Feb 26, 2020 · 1 comment
Labels
Issue: Feature Request New feature or improvement to existing feature

Comments

@neomatrix369
Copy link
Contributor

neomatrix369 commented Feb 26, 2020

Description

For both first-time developers or seasoned developers it would be good to have some defined workflow under a section in the CONTRIBUTING.md file.

Context

I couldn't find the first things to do to make sure I can build kedro and also next steps in the workflow once we are familiar with kedro.

For e.g. have a look at https://kedro.readthedocs.io/en/stable/02_getting_started/01_prerequisites.html, then run these commands the first-time:

make
...

and then onwards always run these:

make ...
...

Before pushing the branch and creating the pull request to the repo.

Possible Implementation

Amend the docs, add links or resources that already exists on the README page. It's highly likely these things already exist but they might be spread across different places in the repo or in the ReadTheDocs page(s).

Possible Alternatives

Ask kedro experts at a face-to-face session or raise an issue on github

@neomatrix369 neomatrix369 added the Issue: Feature Request New feature or improvement to existing feature label Feb 26, 2020
neomatrix369 added a commit to neomatrix369/kedro that referenced this issue Feb 26, 2020
@neomatrix369
Copy link
Contributor Author

Closing as PR is merged now!

neomatrix369 added a commit to neomatrix369/kedro that referenced this issue Feb 28, 2020
…elated to issue kedro-org#256. Added new release notes entry for PR kedro-org#268, related to issue kedro-org#265
neomatrix369 added a commit to neomatrix369/kedro that referenced this issue Feb 28, 2020
…elated to issue kedro-org#256. Added new release notes entry for PR kedro-org#268, related to issue kedro-org#265

[skip ci]
neomatrix369 added a commit to neomatrix369/kedro that referenced this issue Feb 28, 2020
neomatrix369 added a commit to neomatrix369/kedro that referenced this issue Mar 2, 2020
…elated to issue kedro-org#256. Added new release notes entry for PR kedro-org#268, related to issue kedro-org#265

[skip ci]
neomatrix369 added a commit to neomatrix369/kedro that referenced this issue Mar 2, 2020
neomatrix369 added a commit to neomatrix369/kedro that referenced this issue Mar 9, 2020
neomatrix369 added a commit to neomatrix369/kedro that referenced this issue Mar 9, 2020
…elated to issue kedro-org#256. Added new release notes entry for PR kedro-org#268, related to issue kedro-org#265

[skip ci]
limdauto added a commit that referenced this issue Mar 10, 2020
neomatrix369 added a commit to neomatrix369/kedro that referenced this issue Mar 10, 2020
…elated to issue kedro-org#256. Added new release notes entry for PR kedro-org#268, related to issue kedro-org#265

[skip ci]
neomatrix369 added a commit to neomatrix369/kedro that referenced this issue Mar 15, 2020
…elated to issue kedro-org#256. Added new release notes entry for PR kedro-org#268, related to issue kedro-org#265

[skip ci]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Issue: Feature Request New feature or improvement to existing feature
Projects
None yet
Development

No branches or pull requests

1 participant