repo-reviews.github.io

repo-reviews.github.io

Support the community with a helpful ❤️ repo review ❤️

Repo Reviews

| Project Source | Website | Create a review | Why? |

Support the community with a helpful ❤️ repo review ❤️ Please consider giving this repo a ⭐!

About

Mission

Increase productivity and success in the GitHub community with a transparent, trusted forum that publishes user experiences.

Why?

GitHub repos don’t include stories of user experiences.

The purpose of reviews is not to flag issues, but share UX stories. For example:

  • a repo could be working as intended, but might not be a suitable fit for a particular user, stack, or implementation
  • a repo could be losing momentum, core team moved on, or have other development meta-issues that would be helpful sharing
  • particularly critical issues are wontfix or not planned or on a long-term dev roadmap
  • multiple repos could be attempting to achieve the same goal, the process of comparing repos can be very time-consuming

💡 In these cases, it can save a person, team, or company hours, if not days of work to read through reviews.

Hence a tool for sharing UX stories in an independent, transparent, and centrally-located repo.

Sharing UX stories can avoid rabbit-holes and save time, greatly increasing productivity across the community.

Add badges

Github

  • Add the Review me badge to your repo's README.md by copying the code below:
<a href='https://github.com/repo-reviews/repo-reviews.github.io/blob/main/create.md' target="_blank"><img alt='Github' src='https://img.shields.io/badge/review_me-100000?style=flat&logo=Github&logoColor=white&labelColor=888888&color=555555'/></a>

Github

  • Add the View reviews badge to your repo's README.md by copying the code below:
<a href='https://repo-reviews.github.io/repos' target="_blank"><img alt='Github' src='https://img.shields.io/badge/view_reviews-100000?style=flat&logo=Github&logoColor=white&labelColor=888888&color=555555'/></a>
  • Pro-tip: Modify the above code to link directly to your repo's reviews with: https://repo-reviews.github.io/repos/{REPO_OWNER}_{REPO_NAME}.

Getting started

Becoming a 🚀 reviewer takes 🤓, ❤️, and 💪.

The best reviews share insights that are not widely known by the majority of the community, but that would save them hours of work to discover.

For instance, not many people need to know that Node.js is a great JavaScript runtime and that it is easy to set up. Is there something about a particular implementation that you have discovered through experience that would help the community? Perhaps there's an alternative, or a configuration that works well... or doesn't.

Great reviews often result from the ✨ in: 😓😓😓❤️😓😓😓💪😓😓😓✨✨🤓🚀

Note: an experience is not an issue (issues should be reported via a repo's /issues endpoint).

A good place to start is by reviewing trending repositories that are under active development.

Contributing

The site is open source (here's all the code!) and is a tool for and by the community.

Submit issues and pull requests for reviews, site ideas or copy edits.

We are actively recruiting developers (ruby/jekyll) and moderators. Interested? Post an issue and we will reach out.

Under the Hood

This site is made with Jekyll, an open source static site generator. This means the Jekyll program takes the content we want to be on the site and turns them into HTML files ready to be hosted somewhere. Awesomely, GitHub provides free web hosting for repositories, called GitHub Pages, and that's how this site is hosted.

Credit

Thank you to the contributors at government.github.com for providing a framework for building this site.