Skip to content

docs: add contributing badge and fix header / build-status image links in README.md#1

Open
PeterPedegru wants to merge 1 commit intoUXDProtocol:masterfrom
PeterPedegru:patch-1
Open

docs: add contributing badge and fix header / build-status image links in README.md#1
PeterPedegru wants to merge 1 commit intoUXDProtocol:masterfrom
PeterPedegru:patch-1

Conversation

@PeterPedegru
Copy link

Added a contributing badge and fixed several README image links to improve presentation and contributor onboarding.

Files changed:

  • README.md

Current behavior

  • The README referenced a build-status image and header image that resulted in broken/404 renders.
  • There was no prominent contributing badge linking to the repository CONTRIBUTING.md.

New behavior

  • README now shows a working build-status badge sourced from the repository's GitHub Actions.
  • README header image URL has been updated to a valid URL to ensure proper rendering.
  • A contributing badge has been added and links directly to the CONTRIBUTING.md file to help new contributors find guidelines quickly.

Breaking changes

None — documentation-only update.

Other information / notes for maintainers

  • All changes only affect README assets and links.
  • If maintainers prefer different badge styles, hosts, or wish to use locally committed images instead of remote URLs, I can adapt the PR accordingly.
  • Happy to split these into separate commits/PRs if you prefer one fix per PR.

…mage links

- Added a "Contributing" badge linking to https://github.com/UXDProtocol/anchor/blob/master/CONTRIBUTING.md to improve discoverability of contribution guidelines.
- Replaced the old build status image with the GitHub Actions workflow badge (https://github.com/coral-xyz/anchor/actions/workflows/tests.yaml/badge.svg) because the previous CI badge pointed to a non-existent resource.
- Updated the header image URL to a working camo.githubusercontent.com link to avoid 404s in README rendering.

Rationale:
- Fixes broken/missing image links and adds a clear route to contribution instructions.
- Documentation-only change; no code or functional impact.
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