Skip to content

Repository files navigation

Good First Issue

Want to contribute to open source projects but don't know where to start?

Some Open Source projects tag issues suitable for newcomers with a specific label on Github. This app centralizes these issues to make it easier for newcomers to contribute.

Installation instructions

The app is running on Ruby on Rails.

Assuming you have a working ruby and node developement environment:

  • clone the project
  • bundle install
  • yarn install
  • bunde exec rake db:create
  • bundle exec rails server
  • Visit http://localhost:3000/

Enhancement ideas

Frontend

  • Make the labels use the same color as on Github.
  • Collapse repositories that have a large number of issues behind a "see more" link.
  • Add an admin interface to administrate repositories.

Backend

  • Add authentification to the Github API to avoid rate limitation when using the public API.
  • Add a caching layer to only periodically fetch the issues from Github.
  • Persist the respositories and labels in the database instead of hardcoding them.
  • Persist the issues and run a background job to updated them instead of fetching them on every request.

Deployment

  • Add a CI integration to run the tests on PRs.
  • Setup a deployment pipeline and a staging environment.

About

Get started working on open source projects

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages