-
Notifications
You must be signed in to change notification settings - Fork 48
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
Switch to more modern project structure with GitHub Actions #313
Comments
@PaulWAyers @FarnazH @evohringer I know some of you have worked out a proper code of conduct before. It would be good to include it while I'm refreshing the repo. My 7-character code of conduct "be nice" probably falls short of expectations, so I'm happy to include something more substantial and welcoming. |
We store the code-of-conduct, contributing guidelines, and other "universal to QC-Devs repositories" information in this repository: In the TL;DR part of the code of conduct, we capture Toon's "be nice" 7-character summary but lengthened it to a tweet-sized bite.
|
@PaulWAyers @FarnazH @evohringer I'm sorry for the Git spam! I just release 1.0.0a3, which you should be able to install with If you send me your PyPI usernames, I can make you co-owner of the |
Overview of the slowest tests, to be excluded from coverage analysis:
|
I am going to close this issue because the only remaining item is now organized in a separate issue: theochem/.github#5 |
This issue replaces some older ones and is used to keep track of several pull requests to reorganize the repository.
I will edit this TODO list to keep it up to date with merged pull requests and suggestions made below:
setup.py
bypyproject.toml
. Fixed in Initiate switch to more modern GitHub Actions #312.__version_tuple__
from._version
See Ruff #315master
branch tomain
.ruff format
to pre-commit config. See https://docs.astral.sh/ruff/formatter/ (Almost identical to black, faster, will be integrated intoruff
in the future) See Ruff format #314ruff
to pre-commit config. (Instead of all other linting tools) See https://docs.astral.sh/ruff/ See Ruff #315importlib_resources
try-except blocks. See Remove import_resources try-except block #323iodata
releases on PyPI, so there is only theqc-iodata
package on PyPI--nitpicky
option tosphinx-build
in.github/workflows/sphinx.yaml
,docs/Makefile
anddocs/make.bat
. Fix all broken references reported by Sphinx with this option enbaled. See Build documentation with the--nitpicky
option #334CONTRIBUTING.md
file in the.github
repository. We can also add templates for issues and pull requests here. See Update contributing guide #332 and Refer to central contributing guide and add code of conduct #339pytest --durations=100
@pytest.mark.slow
as documented here: https://docs.pytest.org/en/6.2.x/mark.html#registering-marks..github/workflows/pytest.yaml
pytest.yaml
to upload coverage artifacts to deepsource, as documented here: https://docs.deepsource.com/docs/analyzers-test-coverage and https://docs.deepsource.com/docs/analyzers-test-coverage#with-github-actionsI'll use
iodata
as the first test for this structure, but I've got positive experiences with most steps from other repositories.Other relevant links not fully covered here:
Relevant older issues and pull requests that were closed and are followed up here:
The text was updated successfully, but these errors were encountered: