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

Enhancement: add tests, pre-commit, and coverage support #1244

Closed
6 of 7 tasks
Saransh-cpp opened this issue Apr 13, 2023 · 4 comments
Closed
6 of 7 tasks

Enhancement: add tests, pre-commit, and coverage support #1244

Saransh-cpp opened this issue Apr 13, 2023 · 4 comments

Comments

@Saransh-cpp
Copy link
Contributor

Saransh-cpp commented Apr 13, 2023

This is a placeholder issue for testing related developments of DeepXDE. Things I am planning to work on in the next couple of months -

  • Add pre-commit support for better linting, formatting, and readability of the codebase
  • Add integration tests (test all examples)
  • Add basic testing infrastructure using pytest
  • Add basic coverage infrastructure using pytest-cov
  • Add Codecov integration for better coverage statistics on GitHub
  • Add more and more tests to bring the coverage value up
  • Add docs about testing and encourage developers to add a test with every new feature added to DeepXDE
@pescap
Copy link
Contributor

pescap commented Jun 19, 2023

Happy to help! This would greatly improve the package!

@Saransh-cpp
Copy link
Contributor Author

Thanks @pescap! Apologies for abandoning this. I'll start some discussions here next week, along with finishing up the open PR.

@Saransh-cpp
Copy link
Contributor Author

I think this can now be closed. The unchecked point aimed at adding automatic formatters, static code checkers, and linters using pre-commit and pre-commit.ci in DeepXDE's CI, but I would wait for everyone's opinion on that. I'll be happy to add them to the CI if they are needed!

@lululxvi
Copy link
Owner

lululxvi commented Oct 1, 2023

Sounds good. I don't have experience on pre-commit and pre-commit.ci. So feel free to close.

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

No branches or pull requests

3 participants