Skip to content
This repository has been archived by the owner on Feb 22, 2023. It is now read-only.

Add pre-commit, format all files, and add justfile #224

Merged
merged 5 commits into from
Sep 22, 2021

Conversation

sarayourfriend
Copy link
Contributor

Fixes

Fixes #193 by @sarayourfriend
Fixes #187 by @sarayourfriend

Description

Adds pre-commit using the same configuration as the openverse-catalog with some modifications to ignore rules in certain files that were problematic.

Also adds a justfile to make docker stuff easier.

Technical details

I had to add some noqa comments for long strings (I wish flake8 would ignore strings...)

I also added .flake8 that mirrors the pre-commit configuration for flake8 so that editor integration will work

Tests

Checkout the branch and run just install then just lint and ensure that there are no errors reported.

Checklist

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the default branch of the repository (main or master).
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible errors.

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@sarayourfriend sarayourfriend requested a review from a team as a code owner September 21, 2021 20:51
@sarayourfriend sarayourfriend mentioned this pull request Sep 21, 2021
7 tasks
Copy link
Contributor

@AetherUnbound AetherUnbound left a comment

Choose a reason for hiding this comment

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

Looks good! Just one thought for re-ordering

justfile Outdated Show resolved Hide resolved
@sarayourfriend sarayourfriend added python ✨ goal: improvement Improvement to an existing user-facing feature 💻 aspect: code Concerns the software code in the repository labels Sep 21, 2021
Copy link
Member

@dhruvkb dhruvkb left a comment

Choose a reason for hiding this comment

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

This is so awesome! 👍

Copy link
Contributor

@obulat obulat left a comment

Choose a reason for hiding this comment

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

I missed 'just' when coming from the catalog repository :) Thank you for improving DX!

Copy link
Member

@dhruvkb dhruvkb left a comment

Choose a reason for hiding this comment

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

@sarayourfriend this PR does not update the README.md file in the root? #201 had that updated to match the just commands.

@sarayourfriend
Copy link
Contributor Author

@dhruvkb whoops, I missed that when moving things over to this branch, I'll update the README now. Thanks for catching that!

@sarayourfriend sarayourfriend added 🤖 aspect: dx Concerns developers' experience with the codebase and removed 💻 aspect: code Concerns the software code in the repository labels Sep 22, 2021
@sarayourfriend sarayourfriend merged commit 3768ebc into main Sep 22, 2021
@sarayourfriend sarayourfriend deleted the feat/pre-commit branch September 22, 2021 16:11
@zackkrida
Copy link
Member

such excellent work @sarayourfriend 🎉 can't wait to use these commands. thank you

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
🤖 aspect: dx Concerns developers' experience with the codebase ✨ goal: improvement Improvement to an existing user-facing feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Quality] Use black and isort [Quality] Pre-commit hooks
5 participants