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

Updated the CONTRIBUTING.md guide: developer workflow #266

Merged
merged 4 commits into from
Feb 28, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,37 @@ Working on your first pull request? You can learn how from these resources:
* [First timers only](https://www.firsttimersonly.com/)
* [How to contribute to an open source project on GitHub](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github)

### Developer Workflow

#### First time (one-off)

Ensure you have done these:

- [ ] Read through the pre-requisites in the [ReadTheDocs documentation](https://kedro.readthedocs.io/en/stable/02_getting_started/01_prerequisites.html).
- [ ] Run the below commands:
```
make install-test-requirements
make install-pre-commit
```
- [ ] Once the above commands have executed successfully, do a sanity check to ensure that `kedro` works in your environment:
```
make test
make build-docs
```

#### Then onwards (code or documentation changes)

If you picked up a code or documentation related issue, before pushing the branch to the repo and creating a Pull Request please do the below:

- [ ] for code changes:
```
make test
```

- [ ] for documentation related changes:
```
make build-docs
```

### Guidelines

Expand Down
2 changes: 2 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,12 @@
## Bug fixes and other changes

* Fixed the link to the Kedro banner image in the documentation.
* Updated contribution process in `CONTRIBUTING.md` - added Developer Workflow

## Breaking changes to the API

## Thanks for supporting contributions
[Mani Sarkar](https://github.com/neomatrix369)

# 0.15.6

Expand Down