Skip to content

Fix/fixes to contributing.md#12184

Merged
RayBB merged 16 commits into
internetarchive:masterfrom
Sadashii:fix/fix-wiki-links
Mar 24, 2026
Merged

Fix/fixes to contributing.md#12184
RayBB merged 16 commits into
internetarchive:masterfrom
Sadashii:fix/fix-wiki-links

Conversation

@Sadashii

@Sadashii Sadashii commented Mar 24, 2026

Copy link
Copy Markdown
Collaborator

Fixes and changes to CONTRIBUTING.md

Stakeholders

@RayBB

Copilot AI review requested due to automatic review settings March 24, 2026 15:11

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

Updates CONTRIBUTING.md to adjust formatting and modernize references (notably around testing guidance) for contributors reading the project’s contribution workflow.

Changes:

  • Adds a top-of-file separator (---) and minor spacing/blank-line adjustments.
  • Cleans up the “Picking Good First Issues” paragraph formatting.
  • Replaces the old testing link and removes the embedded pre-commit hooks section in favor of a single docs link.

Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md

> **_Warning:_** If you don't clone with **ssh** then infogami will have pre-commit issues [You can read this section to resolve it](docker/README.md#cloning-the-open-library-repository).

See https://docs.openlibrary.org/developers/tools/testing.html for more information.

Copilot AI Mar 24, 2026

Copy link

Choose a reason for hiding this comment

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

The Testing section now only contains a bare URL and drops the previous local guidance about using pre-commit. Since this repo is configured to use pre-commit (see .pre-commit-config.yaml) and contributors are told elsewhere that a pre-commit bot may push commits, consider keeping a short pre-commit pointer here (or linking to the relevant docs) and format the URL as a Markdown link for readability.

Suggested change
See https://docs.openlibrary.org/developers/tools/testing.html for more information.
See the [testing guide](https://docs.openlibrary.org/developers/tools/testing.html) for more information, including how to run tests locally. This repository also uses [`pre-commit`](https://pre-commit.com); consider installing it so you can run the same checks locally before you push.

Copilot uses AI. Check for mistakes.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Comment thread CONTRIBUTING.md Outdated

@RayBB RayBB left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Exactly what we discussed. Thank you!

@RayBB RayBB merged commit eb45217 into internetarchive:master Mar 24, 2026
1 of 2 checks passed
@RayBB RayBB self-assigned this Mar 31, 2026
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.

3 participants