Skip to content

Conversation

anstadnik
Copy link
Collaborator

@anstadnik anstadnik commented May 18, 2023

Suggestions for CI and code quality:

  • Jupyter book could be used as an example for the library usage. Also, it could contain the example of the paper implementation. .github/workflows/make_book.yml contains the code, which makes a jupyterbook and deploys it. For it to work, I believe that one should only specify files in _toc.
  • .github/workflows/python-publish.yml contains a part for automatically pushing updates to PYPI.
    • I'd prohibit directly merging into main, and instead allow only merging via pull request, if all quality checks are passing. This way, assuming good tests, you can be sure that main would always contain properly working code, and hence it's possible to enable autoupload the package to PYPI (.github/workflows/python-publish.yml also contains commented out examples on how to do that. All that is needed to do is to provide credentials (github actions secrets)).
  • I uncommented the checker, and fixed all of the current errors (check the PR from fix_ruff branch (Fix bugs #19).
  • Also it's possible to use black automatically, but that's a matter of taste. I assume you'd prefere to not do 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.

1 participant