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

pre-commit #2508

Closed
wants to merge 4 commits into from
Closed

pre-commit #2508

wants to merge 4 commits into from

Conversation

ntchen
Copy link
Contributor

@ntchen ntchen commented Feb 2, 2024

📝 Description

Type: 🎢 infrastructure

.pre-commit-config.yaml is added. It includes isort (new), ruff and black.
Text need to be added to the documents:

Setting Up Pre-Commit Hooks

To ensure code quality and consistency, we use pre-commit hooks in this project. Please follow these steps to set up pre-commit on your local machine:

Install pre-commit by running:
pip install pre-commit

Set up the pre-commit hooks with:
pre-commit install

This needs to be done only once per repository. The pre-commit hooks will now automatically run on each commit to ensure your changes meet our code quality standards.

Also, link issues affected by this pull request by using the keywords: close, closes, closed, fix, fixes, fixed, resolve, resolves or resolved.
N/A

📌 Resources

Examples, notebooks, and links to useful references.

🚦 Testing

How did you test these changes?

  • Testing pipeline
  • Other method (describe)
  • My changes can't be tested (explain why)
  • it is an independent file

☑️ Checklist

  • I requested two reviewers for this pull request
  • I updated the documentation according to my changes
  • I built the documentation by applying the build_docs label

Note: If you are not allowed to perform any of these actions, ping (@) a contributor.

@tardis-bot
Copy link
Contributor

*beep* *bop*

Hi, human.

I'm the @tardis-bot and couldn't find your records in my database. I think we don't know each other, or you changed your credentials recently.

Please add your name and email to .mailmap in your current branch and push the changes to this pull request.

In case you need to map an existing alias, follow this example.

@ntchen
Copy link
Contributor Author

ntchen commented Feb 2, 2024

I did not do pre-commit run --all-files, since it influences too many files.

@ntchen ntchen closed this Feb 2, 2024
@ntchen ntchen deleted the pre-commit branch February 2, 2024 05:24
@ntchen ntchen mentioned this pull request Feb 3, 2024
7 tasks
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.

2 participants