Skip to content

Conversation

@Mikekellydev
Copy link
Contributor

This PR updates the README.md to make the repository more approachable for contributors and maintainers.

Changes include:

Replaced boilerplate text with a clear explanation of the project’s purpose

Modernized the look with consistent headings (including emoji for readability)

Added step-by-step instructions for running the site locally (clone, install, serve)

Clarified how to add new projects via _data/projects YAML files

Included badges for build status, license, and contributions

Highlighted the Code of Conduct and community expectations

Simplified test and validation instructions

Why this helps:

Provides a better “first impression” for newcomers

Reduces friction for first-time contributors

Aligns the documentation with the mission of Up-for-Grabs.net — making open source contributions easier to discover and more welcoming

@netlify
Copy link

netlify bot commented Aug 26, 2025

Deploy Preview for up-for-grabs-test-bench ready!

Name Link
🔨 Latest commit b87b5b5
🔍 Latest deploy log https://app.netlify.com/projects/up-for-grabs-test-bench/deploys/68e54ba8912be1000864b345
😎 Deploy Preview https://deploy-preview-5337--up-for-grabs-test-bench.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@shiftbot
Copy link
Contributor

👋 I'm a robot checking the state of this pull request to save the human reviewers time. I don't see any changes under _data/projects/ so I don't have any feedback here.

As you make changes to this pull request, I'll re-run these checks.

@Mikekellydev Mikekellydev marked this pull request as ready for review August 26, 2025 03:18
@Mikekellydev
Copy link
Contributor Author

Mikekellydev commented Aug 26, 2025

👋 Hi maintainers,

This PR is a documentation improvement focused on the README.md. The goal is to make the repo more welcoming and easier for new contributors to get started. I’ve:

📋 PR Improvements Checklist

  • Clear project description replaces placeholder text
  • Modernized headings with consistent formatting and emojis for readability
  • Added step-by-step setup instructions (clone → install → run locally)
  • Documented how to contribute projects via _data/projects YAML files
  • Included badges for build status, license, and contributions
  • Clarified testing and validation commands
  • Highlighted Code of Conduct and community guidelines
  • Improved overall readability and approachability for new contributors

No code functionality has been changed — this is purely a docs/readability update.
Looking forward to your feedback, and happy to adjust anything you’d like refined.

Thanks for all the work you do maintaining this project 🙌

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants