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 pre-commit and some formatting #1449

Open
wants to merge 4 commits into
base: staging
Choose a base branch
from

Conversation

lnxpy
Copy link

@lnxpy lnxpy commented Mar 2, 2024

This PR contains:

  • Ignoring test/third_party_tests/*.db (it gets generated whenever someone runs the tests)
  • Adding pre-commit configurations (using black and check-docstring-first for better code quality insurance)

We can specify which docstring convention should be checked while committing.

⚠️ Based on the changes that I've made, source/dev-guide/contribute.html doc needs to be updated. I can work on them as well.

This PR closes #1347

Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

👋 Hello @lnxpy, thanks for submitting a EVA DB PR 🙏 To allow your work to be integrated as seamlessly as possible, we advise you to:

  • ✅ Verify that your PR is up-to-date with georgia-tech-db/eva master branch. If your PR is behind you can update your code by clicking the 'Update branch' button or by running git pull and git merge master locally.
  • ✅ Verify that all EVA DB Continuous Integration (CI) checks are passing.
  • ✅ Reduce changes to the absolute minimum required for your bug fix or feature addition.

@lnxpy
Copy link
Author

lnxpy commented Mar 2, 2024

👋 Hello @lnxpy, thanks for submitting a EVA DB PR 🙏 To allow your work to be integrated as seamlessly as possible, we advise you to:

  • ✅ Verify that your PR is up-to-date with georgia-tech-db/eva master branch. If your PR is behind you can update your code by clicking the 'Update branch' button or by running git pull and git merge master locally.
  • ✅ Verify that all EVA DB Continuous Integration (CI) checks are passing.
  • ✅ Reduce changes to the absolute minimum required for your bug fix or feature addition.

I think this CI message needs an update too. The default branch is staging not master.

@gaurav274
Copy link
Member

@lnxpy Thanks for the effort, let me fix the build and then merge your PR.

@lnxpy
Copy link
Author

lnxpy commented Mar 9, 2024

Hi @gaurav274!
That's fine! Take your time. Before you merge this, please note that some changes should be made in the docs too.

I'm working on #1348 as well so the contribution guideline will need a major update after that.

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.

Using pre-commit
2 participants