Skip to content

Cleaned up actions and tool configuration#1275

Merged
VisLab merged 6 commits into
hed-standard:mainfrom
VisLab:fix_extras
Mar 20, 2026
Merged

Cleaned up actions and tool configuration#1275
VisLab merged 6 commits into
hed-standard:mainfrom
VisLab:fix_extras

Conversation

@VisLab

@VisLab VisLab commented Mar 20, 2026

Copy link
Copy Markdown
Member

No description provided.

@github-actions

Copy link
Copy Markdown

PR Review: Cleaned up actions and tool configuration

Overall: This is a clean infrastructure/tooling PR with no functional code changes. The only substantive code change is a docstring improvement in hed_id_util.py.

Changes assessed

  • .gitattributes: Removes hed/_version.py export-subst. Dead configuration -- _version.py is auto-generated by setuptools-scm and not tracked in git, so this attribute had no effect. Removal is correct.

  • .github/copilot-instructions.md: New file providing Copilot context for contributors. Content is accurate and largely consistent with CLAUDE.md. One minor note: it states to use Parameters: not Args: -- this is the project convention but differs from standard Google style (which uses Args:). Clarifying this is a project-specific choice (not a bug) would help avoid confusion for new contributors. Not a blocker.

  • .gitignore: Removes the entry that excluded .github/copilot-instructions.md, consistent with now tracking that file. Correct.

  • .lycheeignore to lychee.toml: Good consolidation. The deleted .lycheeignore had an HTML comment on line 1 that lychee would have treated as a literal regex pattern rather than a comment, making it dead/misleading content. The new lychee.toml approach with proper inline # comments is cleaner.

  • hed/schema/schema_io/hed_id_util.py: Minor docstring clarification adding "A key from constants.DF_SUFFIXES." Accurate and helpful.

  • lychee.toml: Exclusion patterns correctly migrated from .lycheeignore, with improved organization via section comments.

Issues

No critical or important issues found. The PR is straightforward infrastructure cleanup with no regressions.

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

This PR consolidates repository tooling/configuration: it migrates Lychee link-checker exclusions into lychee.toml, removes the standalone .lycheeignore, and adds project-specific GitHub Copilot developer instructions alongside a couple of small config/doc cleanups.

Changes:

  • Moved Lychee ignore patterns from .lycheeignore into lychee.toml and deleted .lycheeignore.
  • Added .github/copilot-instructions.md and adjusted .gitignore so it’s tracked.
  • Minor documentation/config cleanups (hed_id_util.py docstring tweak, .gitattributes simplification).

Reviewed changes

Copilot reviewed 5 out of 6 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
lychee.toml Expands exclude list to include previously ignored URLs/patterns directly in the Lychee config.
hed/schema/schema_io/hed_id_util.py Clarifies _get_hedid_range parameter documentation.
.lycheeignore Removed (exclusions migrated into lychee.toml).
.gitignore Stops ignoring .github/copilot-instructions.md so it can be committed.
.github/copilot-instructions.md Adds repository development instructions and workflow overview.
.gitattributes Removes the _version.py export-subst entry.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread lychee.toml
Comment thread hed/schema/schema_io/hed_id_util.py Outdated
Comment thread .github/copilot-instructions.md Outdated
Comment thread .github/copilot-instructions.md Outdated
Comment thread lychee.toml
@github-actions

Copy link
Copy Markdown

PR Review: Cleaned up actions and tool configuration

Overall this is a clean housekeeping PR. One important issue and one suggestion below.

Important

Stale comment in lychee.toml (see inline comment): Line 11 still references .lycheeignore after it is deleted. That comment should be updated or removed.

Verified as safe

  • .gitattributes: Removing hed/_version.py export-subst is safe. hed/_version.py is listed in .gitignore and auto-generated by setuptools-scm, so the export-subst attribute was already a no-op.
  • .gitignore: Removing the exclusion of .github/copilot-instructions.md is correct since the file is now committed to the repo.
  • .lycheeignorelychee.toml: Consolidation is clean. The workflow already invokes lychee with --config lychee.toml, so the explicit migration removes an implicit dependency on the lychee auto-discovery of .lycheeignore.
  • hed_id_util.py docstring: Minor clarification is accurate and correct.

Suggestion

copilot-instructions.md labels the docstring convention as "Google-style" but instructs using Parameters: (which is NumPy/Sphinx style). This is consistent with the existing codebase (which already uses Parameters:), so it won't introduce drift — but the label is technically incorrect and could confuse contributors who know Google style uses Args:. Worth correcting the label to match actual practice.

@VisLab VisLab merged commit 9c70089 into hed-standard:main Mar 20, 2026
22 checks passed
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