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

Adding contribution guide and enable copyright checks as a pre-commit hook #91

Merged
merged 7 commits into from
Sep 19, 2023

Conversation

hatemhelal
Copy link
Contributor

@hatemhelal hatemhelal commented Sep 18, 2023

This patch adds a contribution guide covering setting up a development environment for IPU development. This guide was initially developed for other projects (see hydronet-gnn). While reviewing the steps it occurred to me that we don't have a copyright check (required for OSS) so I've implemented a basic pre-commit hook that applies the flake8-copyright check.

Adds the following test-only dependencies:

@hatemhelal hatemhelal self-assigned this Sep 18, 2023
@hatemhelal hatemhelal linked an issue Sep 18, 2023 that may be closed by this pull request
@hatemhelal hatemhelal changed the title 73 add a contribution guide Adding contribution guide and enable copyright checks as a pre-commit hook Sep 19, 2023
@hatemhelal hatemhelal marked this pull request as ready for review September 19, 2023 07:32
@hatemhelal hatemhelal requested a review from awf September 19, 2023 08:40
Copy link
Collaborator

@awf awf left a comment

Choose a reason for hiding this comment

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

Fab, thanks. Various doc proposals.
On re-looking, I like to separate the temporary shell variable and the "persistent" variable.

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
Co-authored-by: Andrew Fitzgibbon <[email protected]>
CONTRIBUTING.md Outdated Show resolved Hide resolved
@hatemhelal hatemhelal merged commit da38195 into main Sep 19, 2023
4 checks passed
@hatemhelal hatemhelal deleted the 73-add-a-contribution-guide branch September 19, 2023 17:36
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.

Add a contribution guide
2 participants