Skip to content

Conversation

@PeterPedegru
Copy link

Add a CONTRIBUTING badge in README linking to CONTRIBUTING.md for easier discoverability of contribution guidelines.

What I did

Added a small CONTRIBUTING badge to the README header that links to the repository's CONTRIBUTING.md so that contribution instructions are immediately visible to visitors and potential contributors.

fixes: N/A

How I did it

  • Inserted the following badge markdown into the top-of-readme badge block (next to existing CI/status badges):
[![Contributing](https://img.shields.io/badge/CONTRIBUTING-guidelines-brightgreen?style=flat-square)](https://github.com/ApeWorX/ape/blob/main/CONTRIBUTING.md)
  • Committed the change on a new branch and opened this PR for review.
  • Kept formatting consistent with existing badges (flat-square style and spacing).

How to verify it

  1. Open the Pull Request preview or view the modified README.md file in the "Files changed" tab on GitHub.
  2. Confirm the new CONTRIBUTING badge renders correctly in the README header.
  3. Click the badge and verify it navigates to CONTRIBUTING.md in the main branch (or the file path used in the badge).
  4. Verify spacing and visual alignment with adjacent badges (CI, license, etc.) to ensure consistent appearance.

Checklist

  • All changes are completed
  • Change is covered in tests (N/A — documentation-only change)
  • Documentation is complete

Add a CONTRIBUTING badge in README linking to CONTRIBUTING.md for easier discoverability of contribution guidelines.
@github-actions
Copy link

This pull request is considered stale because it has been open 30 days with no activity. Remove stale label, add a comment, or make a new commit, otherwise this PR will be closed in 5 days.

@github-actions github-actions bot added the stale No activity for 30 days label Nov 10, 2025
@fubuloubu fubuloubu enabled auto-merge (squash) November 10, 2025 16:33
@github-actions github-actions bot removed the stale No activity for 30 days label Nov 11, 2025
@fubuloubu fubuloubu self-assigned this Nov 14, 2025
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