Skip to content

Prepare the 0.1.0b1 release of kalelinear - #19

Open
shuo-zhou wants to merge 2 commits into
mainfrom
Release-0.1.0b1
Open

Prepare the 0.1.0b1 release of kalelinear#19
shuo-zhou wants to merge 2 commits into
mainfrom
Release-0.1.0b1

Conversation

@shuo-zhou

Copy link
Copy Markdown
Member

No description provided.

@codecov

codecov Bot commented Aug 16, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 88.71%. Comparing base (3db6ab6) to head (1db37ab).

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #19   +/-   ##
=======================================
  Coverage   88.71%   88.71%           
=======================================
  Files          21       21           
  Lines        1506     1506           
=======================================
  Hits         1336     1336           
  Misses        170      170           

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Prepares the kalelinear project for the 0.1.0b1 beta release by aligning version metadata, updating release notes, and adding/refreshing contributor-facing project templates and policies.

Changes:

  • Bump package version to 0.1.0b1 and update the PyPI development status classifier to Beta.
  • Add contribution/community docs (CONTRIBUTING + Code of Conduct) and GitHub issue/PR templates.
  • Add release notes and changelog automation configuration (plus .gitignore exception for the config).

Reviewed changes

Copilot reviewed 12 out of 13 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
setup.py Bumps package version and updates classifier to Beta.
README.md Links to CONTRIBUTING guidelines.
kalelinear/init.py Bumps __version__ to 0.1.0b1.
CONTRIBUTING.md Adds contributor workflow guidance (pre-commit, CI, testing, releases).
CODE_OF_CONDUCT.md Adds Contributor Covenant code of conduct.
.gitignore Ensures changelog CI JSON config is not ignored.
.github/pull_request_template.md Adds PR template for consistent submissions.
.github/ISSUE_TEMPLATE/refactor.md Adds refactor issue template.
.github/ISSUE_TEMPLATE/feature-request.md Adds feature request issue template.
.github/ISSUE_TEMPLATE/documentation.md Adds documentation issue template.
.github/ISSUE_TEMPLATE/bug-report.md Adds bug report issue template.
.github/CHANGELOG.md Adds release notes section for 0.1.0b1.
.github/changelog-ci-config.json Adds changelog-ci configuration for automated changelog updates.
Suppressed comments (1)

.github/ISSUE_TEMPLATE/documentation.md:21

  • Same spacing issue in bold prompts below (extra spaces inside ** ... **). Removing them improves readability and consistent rendering.
** Is there a feature that needs some example code? **
<!-- Let us know if we are missing any example notebooks -->

** Think you know how to fix the docs? ** (If so, we would love a pull request from you!)

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread CONTRIBUTING.md Outdated
Comment thread .github/changelog-ci-config.json Outdated
Comment thread .github/pull_request_template.md Outdated
Comment thread .github/ISSUE_TEMPLATE/documentation.md Outdated

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 12 out of 13 changed files in this pull request and generated no new comments.

Suppressed comments (8)

.github/changelog-ci-config.json:8

  • The changelog action will skip this release PR because its title starts with “Prepare”, while this regex only accepts titles starting with “release”. Even after renaming the PR, the action’s default SemVer regex extracts only 0.1.0 from the PEP 440 version 0.1.0b1, producing the wrong changelog header. Configure both patterns so this release title and beta version are handled in full.
  "pull_request_title_regex": "^(?i:release)",

.github/changelog-ci-config.json:10

  • Three configured groups rely entirely on labels that do not exist in this repository: Code Improvements, Documentation, and Tests. As a result, these sections can never receive entries. Create the intended labels in repository settings or align this taxonomy with existing labels before enabling the automation.
  "group_config": [

.github/pull_request_template.md:1

  • GitHub does not interpolate {issue_number} in pull request templates, so this remains literal text and will not link or close an issue unless contributors know to replace it. Add an explicit editable prompt instead.
Fixes #{issue_number}.

CONTRIBUTING.md:75

  • pre-commit install writes the hook to the repository’s .git/hooks/pre-commit; kalelinear\\.git\\hooks points inside the package directory and uses an incorrect path separator. This sends contributors looking in a location that is never created.
This installs the `pre-commit` hooks at `kalelinear\.git\hooks`, to be **triggered by each new commit** to automatically run them *over the files you commit*. Several **important** points to note:

.github/changelog-ci-config.json:9

  • The repository’s dependency-update label is dependencies, so the current exclusion list does not exclude those PRs; they will appear under “Other Changes” despite the apparent bot/CI exclusion intent. Add the existing label to the exclusions.

This issue also appears on line 10 of the same file.

  "exclude_labels": ["dependabot", "bot", "ci"],

.github/ISSUE_TEMPLATE/refactor.md:5

  • The repository has no refactor label, so GitHub cannot apply this template’s default label. Create that repository label before merge or select an existing label here.
labels: refactor

.github/ISSUE_TEMPLATE/documentation.md:5

  • The repository has no documentation label, so GitHub cannot apply this template’s default label. Create that repository label before merge or select an existing label here.
labels: documentation

CONTRIBUTING.md:226

  • This manual-update step conflicts with the enabled changelog workflow (commit_changelog: true), which prepends and commits a generated release section when a matching release PR opens. Following both instructions can create duplicate version sections; make the checklist ask maintainers to verify/edit the generated entry instead.
- Update [`.github/CHANGELOG.md`](.github/CHANGELOG.md) with a summary of changes since the last release.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 12 out of 13 changed files in this pull request and generated no new comments.

Suppressed comments (10)

.github/changelog-ci-config.json:25

  • The repository currently has none of the configured documentation, docs, or doc labels, so documentation changes will fall into “Other Changes” instead of this group. Create and apply one of these labels, or map the group to an existing label.
      "title": "Documentation",
      "labels": ["documentation", "docs", "doc"]

.github/changelog-ci-config.json:29

  • The repository currently has none of tests, testing, or test, so this changelog group cannot receive any pull requests through existing labels. Create and use one of these labels, or map the group to an existing label.
      "title": "Tests",
      "labels": ["tests", "testing", "test"]

.github/changelog-ci-config.json:4

  • With commit_changelog enabled, the existing pull_request: opened workflow prepends generated notes to this file. This PR also adds the 0.1.0b1 section manually, and the new checklist instructs maintainers to do the same, so future release PRs will receive a second section for the same version. Choose one source of release notes: rely on the action, or keep manual updates and disable its commit behavior.
  "commit_changelog": true,

.github/changelog-ci-config.json:8

  • Changelog CI v1.2.0 defaults to a SemVer regex and extracts only 0.1.0 from this PR title’s PEP 440 version 0.1.0b1; it then generates the wrong changelog heading. Configure a version regex that consumes Python prerelease suffixes.
  "pull_request_title_regex": "(?i:release)",

.github/changelog-ci-config.json:21

  • None of improvements, refactor, or refactoring currently exists in this repository, so no pull request can enter this group through the configured labels. Create at least one of these labels (and use it consistently) or map this group to an existing label.

This issue also appears in the following locations of the same file:

  • line 24
  • line 28
      "title": "Code Improvements",
      "labels": ["improvements", "refactor", "refactoring"]

.github/ISSUE_TEMPLATE/refactor.md:5

  • GitHub only auto-applies issue-template labels that already exist, but this repository currently has no refactor label. Create that label before merging or select an existing label; otherwise refactor issues opened from this template will be left unlabeled.
labels: refactor

.github/ISSUE_TEMPLATE/documentation.md:5

  • GitHub only auto-applies issue-template labels that already exist, but this repository currently has no documentation label. Create that label before merging or select an existing label; otherwise issues opened from this template will be left unlabeled.
labels: documentation

CONTRIBUTING.md:75

  • .git\hooks is not the repository hook path on Linux/macOS, even though these instructions and CI are cross-platform. Use the platform-neutral Git path separator.
This installs the `pre-commit` hooks at `.git\hooks`, to be **triggered by each new commit** to automatically run them *over the files you commit*. Several **important** points to note:

CONTRIBUTING.md:215

  • The package version used by this release (0.1.0b1) is a PEP 440 identifier, not valid SemVer prerelease syntax (which requires a hyphen). The release guidance should distinguish Python’s version syntax from the MAJOR/MINOR/PATCH compatibility policy.
We follow the [Semantic Versioning](https://semver.org/) guidelines. Given a version number `MAJOR.MINOR.PATCH`, increment the:

.github/ISSUE_TEMPLATE/bug-report.md:30

  • The spaces inside these emphasis markers prevent this prompt from rendering as bold in standard Markdown. Remove them, as was done for the other template prompts.
** Stack trace/error message **

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.

2 participants