HARK
HARK copied to clipboard
[WIP] Cookie
This pull request includes a variety of changes to improve the project's configuration, documentation, and continuous integration workflows. The most important changes include adding detailed contribution guidelines, setting up continuous integration and continuous deployment workflows, and updating pre-commit hooks.
Configuration and Documentation Improvements:
.github/CONTRIBUTING.md: Added detailed contribution guidelines, including instructions for setting up a development environment, running tests, and building documentation..readthedocs.yaml: Added a configuration file for Read the Docs to specify the build environment and commands for generating documentation.
Continuous Integration and Deployment:
.github/workflows/ci.yml: Added a CI workflow to run pre-commit hooks, linting, and tests on multiple operating systems and Python versions..github/workflows/cd.yml: Added a CD workflow to build and publish the package to PyPI upon release..github/dependabot.yml: Configured Dependabot to maintain dependencies for GitHub Actions.
Pre-commit Hooks:
.pre-commit-config.yaml: Updated and added new pre-commit hooks for code formatting, linting, and validation.
Documentation Updates:
.github/workflows/documentation.yml: Updated paths and commands to reflect the new documentation structure. [1] [2] [3] [4]Documentation/overview/index.rst: Removed outdated documentation structure.
Please ensure your pull request adheres to the following guidelines:
- [ ] Tests for new functionality/models or Tests to reproduce the bug-fix in code.
- [ ] Updated documentation of features that add new functionality.
- [ ] Update CHANGELOG.md with major/minor changes.
Codecov Report
All modified and coverable lines are covered by tests :white_check_mark:
Project coverage is 60.89%. Comparing base (
bbb07a5) to head (0a40818). Report is 586 commits behind head on master.
Additional details and impacted files
@@ Coverage Diff @@
## master #1514 +/- ##
===========================================
- Coverage 71.53% 60.89% -10.65%
===========================================
Files 83 54 -29
Lines 13938 14017 +79
===========================================
- Hits 9971 8535 -1436
- Misses 3967 5482 +1515
:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.