Skip to content

Conversation

jmgate
Copy link
Collaborator

@jmgate jmgate commented Jun 25, 2024

Final tweaks while finishing up the open sourcing of this package.

Commits

  1. ci: Check documentation spelling and coverage (e5b3719)

  2. patch: Indicate that the package is typed (55a20c9)

    According to PEP 561, we need to add this file to static type checkers can infer the types from the package.

  3. ci: Add semantic release templates (0cb13c1)

    Add templates for the release notes and CHANGELOG so python-semantic-release can generate these files correctly in CI.

  4. chore: Add example requirements (343b8e7)

    Add a blank requirements file for the examples to facilitate adding requirements in the future.

  5. chore: Add CHANGELOG (c5ce0f4)

    Add a dummy CHANGELOG.md to be overwritten by Semantic Release.

  6. docs: Slight tweaks to contributing guidelines (59325de)

  7. ci: Omit --fix arg (2207516)

    When running ruff via pre-commit, don't automatically fix the problems; instead tell the user what's wrong to train them into not making the problems in the first place.

  8. test: Run the examples and check their output (ccfa0d9)

@jmgate jmgate self-assigned this Jun 25, 2024
Copy link

codecov bot commented Jun 25, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (06237fb) to head (ccfa0d9).
Report is 151 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff            @@
##            master       #27   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            2         2           
  Lines          180       180           
  Branches        21        21           
=========================================
  Hits           180       180           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@jmgate jmgate changed the title ci: Check documentation spelling and coverage Final tweaks Jun 27, 2024
@jmgate jmgate force-pushed the final-tweaks branch 5 times, most recently from 9c24d80 to 54fd6e2 Compare July 1, 2024 20:05
jmgate added 7 commits July 1, 2024 14:15
According to PEP 561, we need to add this file to static type checkers
can infer the types from the package.
Add templates for the release notes and `CHANGELOG` so
`python-semantic-release` can generate these files correctly in CI.
Add a blank requirements file for the examples to facilitate adding
requirements in the future.
Add a dummy CHANGELOG.md to be overwritten by Semantic Release.
When running `ruff` via pre-commit, don't automatically fix the
problems; instead tell the user what's wrong to train them into not
making the problems in the first place.
@jmgate jmgate force-pushed the final-tweaks branch 5 times, most recently from 5ba938d to 9cb978a Compare July 2, 2024 14:06
@jmgate jmgate mentioned this pull request Jul 2, 2024
@jmgate jmgate force-pushed the final-tweaks branch 2 times, most recently from 5b85053 to 28c1854 Compare July 2, 2024 14:13
@jmgate jmgate merged commit 59cf4d2 into master Jul 2, 2024
@jmgate jmgate deleted the final-tweaks branch July 2, 2024 14:21
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