24pullrequests/24pullrequests

:christmas_tree: Giving back to open source for the holidays

24 Pull Requests

🎄 Giving back little gifts of code

24 Pull Requests is a yearly initiative to encourage contributors around the world to send 24 pull requests between December 1st and December 24th.

This is the site to help promote the project, highlighting why, how and where to send your pull requests.

Table of Contents

• 24 Pull Requests
  • Table of Contents
  • Get started
  • Contributors
  • Development
    • Getting Started
      • Installing a Local Server
      • Installing using docker
    • Tests
    • Contributing
    • Translations
    • Code of Conduct
  • Copyright

Get started

• Explore projects to help
• Submit your project to get help

Contributors

Over hundreds of different people have contributed to the project, you can see them all here: https://github.com/24pullrequests/24pullrequests/graphs/contributors

Development

The source is hosted at GitHub.

You can report issues/feature requests on GitHub Issues. You can use GitHub Discussions to ask questions, follow announcements, and to propose ideas for the 24pullrequests project. Follow the project on Mastodon @24pullrequests.

These instructions are for working on the the 24pullrequests.com website. If you just want to be a developer who contributes PRs during the holidays, you don't need to follow these instructions! Go to https://24pullrequests.com and get involved there.

Getting Started

Want to hack on the website? Awesome!

New to Ruby? No worries! You can follow these instructions to install a local server, or you can use the included Vagrant setup.

Installing a Local Server

First things first, you'll need to install Ruby 3.2.2. I recommend using the excellent rbenv, and ruby-build.

rbenv install 3.2.2
rbenv global 3.2.2

Next, you'll need to make sure that you have PostgreSQL installed. This can be done easily on macOS using Homebrew or by using https://postgresapp.com. Please see these further instructions for installing Postgres via Homebrew.

brew install postgres
brew install chrome-cli

On Debian-based Linux distributions you can use apt-get to install Postgres:

sudo apt-get install postgresql postgresql-contrib libpq-dev

On Windows, you can use the Chocolatey package manager to install Postgres:

choco install postgresql

Clone this repository:

git clone [email protected]:24pullrequests/24pullrequests.git

Now, let's install the gems from the Gemfile ("Gems" are synonymous with libraries in other languages).

gem install bundler && rbenv rehash
bundle install

Once all the gems are installed, we'll need to create the databases and tables. Rails makes this easy through the use of "Rake" tasks.

bundle exec rake db:create:all
bundle exec rake db:migrate

And we can also add some sample data with the seed task.

bundle exec rake db:seed

If you are working on anything related to the email-generation code, you can use MailCatcher. Since we use Bundler, please read the following before using MailCatcher.

Almost there! Now all we have to do is start up the Rails server and point our browser to http://localhost:3000

bundle exec rails s

Installing using docker

To streamline the installation process and avoid manual setup, you can use Docker and Docker Compose.

Before you begin, ensure you have the following installed:

• Docker
• Docker Compose

Clone this repository:

git clone [email protected]:24pullrequests/24pullrequests.git
cd 24pullrequests

Build the docker image using the command below. This will install all the dependencies and create the database.

# Build the Docker image and install dependencies
docker compose build

Once the image is built, you can start the server using the command below.

# Pulls PostgreSQL, creates/migrates the database, and starts the server
docker compose up

The server is up and available at: http://localhost:3000

Tests

Standard RSpec/Capybara tests are used for testing the application. The tests can be run with bundle exec rake.

You can set up the test environment with bundle exec rake db:test:prepare, which will create the test DB and populate its schema automatically. You don't need to do this for every test run, but it will let you easily keep up with migrations. If you find a large number of tests are failing you should probably run this.

If you are using the omniauth environment variables (GITHUB_KEY, GITHUB_SECRET) for another project, you will need to either

• unset them before running your tests or
• reset the omniauth environment variables after creating a GitHub (omniauth) application for this project

as it will use it to learn more about the contributors and for pull requests.

If you are using the Docker setup, you can run the tests:

• Overall tests: docker compose run app bundle exec rake
• Specific tests: docker compose run app bundle exec rake SPEC=./spec/path/to/test_spec.rb
• Specific lines: docker compose run app bundle exec rake SPEC=./spec/path/to/test_spec.rb:123

Contributing

We are always looking for people to contribute! To find out how to help out, have a look at our Contributing Guide.

Translations

24 Pull Requests is available in twenty languages. Translations are managed on Transifex. Authentication is required to use Transifex. If you prefer to edit the translations directly you can use the standard Rails i18n framework. To get started:

• Fork the project.
• Create a copy of config/locales/en.yml within the locales folder.
• Amend the first line with the correct character set you'll be translating to.
• Translate the strings and submit a pull request for the new translation.

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Copyright

Copyright MIT © 2021 Andrew Nesbitt. See LICENSE for details.

24pullrequests's Issues

Group pull requests by day

Separate lists of pull requests into groups based on the day, 1st December for example, so it's easier to see how regular things are being done.

Daily email reminder

After logging in, users can opt-in for daily or weekly reminder emails with suggested projects to work on and a summary of their progress so far, also need to be able to unsubscribe or change frequency from links in the email.

Add or improve copy on Email Preferences form

Explain form better and what happens if they give their email

Should work for both new users and existing users changing their preferences.

Quotes from well respected devs encouraging people to get involved

Get some quotes from well known people in the dev community about the project on the homepage.

Peter Cooper said "An interesting, programmer-related spin on the advent calendar!"

Add custom heading fonts

Adams design uses Proxima Nova which is available from typekit https://typekit.com/fonts/proxima-nova, needs to be applied to all the headings.

Tests!

The site is getting more complex now, no longer a couple of html pages and then run them on https://travis-ci.org

Nicer introduction flow

When a user visits the site it should be obvious what to do to get involved.

1. Login with github oauth (done)
2. Asked if they want to get email notifications (wip by @clowder)
3. Shown a 1-2-3 step guide to contributing once a day.
4. Offered Suggested projects to work on.

I'd do this as a bit of a wizard after logging in the first time but I don't mind how its implemented.

Invalid project urls

There are several projects that have invalid urls such as missing http. Worth adding some code to prevent or fix?

The ones I just found: 319, 295, 322

Exception tracking

https://bugsnag.com

Add a global stream of pull requests

The pull requests are starting to come in (http://24pullrequests.com/timoschilling), would be great to see a page which lists them all and maybe feature a few recent ones on the homepage.

SCIKIT-LEARN twice in the project listing

Hi,

Even-though it might be just me not getting the idea it seems that SCIKIT-LEARN is listed twice at this page: http://24pullrequests.com/projects

I suppose the one pointing at https://github.com/scikit-learn/scikit-learn is the right one and should be listed there.

I'd actually submit a pull request but this requires a DB operation which makes it pointless. Maybe checking whether the repo name is already in the database might make some sense, though.

Redirect back to where you meant to go after login

When you try and access a page that requires login (dashboard, projects#new etc) you should be bounced to a page that explains you need to login with github, and has a button, sets a cookie of your previous attempted location and then when you return from logging into github you get redirect back to that attempted location.

Needs a favicon

Artwork available in the design folder

[LINK] More projects that could use help

I can't remember where I heard about this... some podcast most likely.
Issue Triage
Would be cool to see it very active.

Homepage design tinkerings

All titles (including buttons) to be lowercase apart from project titles and developers already involved.

Developers Box:

• Add 30px padding top and bottom to
• background gradient from #FFF to #F1F1F1

Suggested Projects:

• Title to be 28px
• Buttons to be 18px and font-weight:normal
• Title box to have border-bottom: 1px solid #EEE; margin-bottom: 20px; padding-bottom: 20px;

Improve design of pull_request partial

Include users avatar, less text in the headings (only the name of the pull request) and break/hyphenate long branch names to avoid them breaking out of the layout.

Do not add projects with existing link

There are a lot of duplicate of projects here http://24pullrequests.com/projects such as rails https://github.com/rails/rails

Pull request caching

Two things around loading users pull requests:

• Need to use the users oauth access token to access their pull requests, otherwise we hit the github rate limit to quickly, this requires:
  • Saving the access token on login to the user
  • refactoring the pull request class to use octokit and the access token
• Varnish is not available to the cedar stack on heroku, so my lazy plan of caching the pages rather than storing pull requests is dead, so instead:
  • Store pull requests for a user in the db
  • A cron task that downloads users pull requests on a regular basis

Only showing December pull requests is broken

I've commented out the code for the moment, didn't have time to look into what was wrong

Add google analytics tracking

Improve user navigation

Currently there is no easy way for the user to navigate around the site once logged in, fix that.

Also, show/hide login/logout as appropriate.

Pull requests not showing up in app.

Opening an issue since this hasn't showed up for around four hours and this tweet ( https://twitter.com/24PullRequests/status/274927310577225728 ) advises that it should be pulling hourly.

Pull request was issued from this account. Here's the request in question: hdgarrood/value_object#1

Awesome project, guys.

Test in IE

I didn't get time to do a good cross-browser check, specifically IE, firefox or opera.

Add Heroku as a sponsor on the about page

Heroku have kindly provided us with free hosting and an upgraded Postgres database, we should add their logo from here: http://logos.heroku.com and link it to here: http://postgres.heroku.com

Must be logged in to suggest a project

Should help avoid spam and encourage more users

Full width section backgrounds

Need to finish the full width colored background sections on the homepage to match with the psd

Implement new design

Adam is working on a much nicer design, once ready it needs to be implemented.

Filter by language js is broken

Need to move away from using rows in the projects grid so quicksand doesn't get confused!

Duplicate project submission

The same user/repo on github can be submitted multiple times, which may or may not be a bug. I had to submit a second time because of the language filter bug (#39).

Explain what the users page is about to visitors.

Show a message on user profile for non-logged in visitors explaining what the page is about.

Something like "andrew is doing 24 pull requests, giving little bits of code back for xmas, why not join him? #{homepage link}"

Add a "Sending Pull Requests" Guide page

A page to help out people new to contributing containing content similar to:

• https://help.github.com/articles/using-pull-requests
• http://thechangelog.com/post/5367356233/you-yes-you-should-contribute-to-open-source
• http://blog.smartbear.com/software-quality/bid/167051/14-Ways-to-Contribute-to-Open-Source-without-Being-a-Programming-Genius-or-a-Rock-Star
• http://www.hanselman.com/blog/GetInvolvedInOpenSourceTodayHowToContributeAPatchToAGitHubHostedOpenSourceProjectLikeCode52.aspx

Add or improve copy on Project submission form

• Explain form
• suggest user creates issues for bugs they would like fixing
• add a back or cancel button

Store last_sent_at on user

If there is an error when sending out emails it would be good to know who has been sent what and when, in the form of a last_sent_at column on users which is updated after being successfully emailed.

This will also help ensure that all new users receive the first email on their first day, even if they choose weekly frequency, and weekly is just 7 days after the last email they received.

Needs a nicer 404 page

Currently using the rails default, would be nice to use the main layout and have a fun message on there.

Fix user nav on mobile

Currently bunches up on portrait phones, should be a bit more minimal or a nice drop down.

Auto-suggestions covered by native suggestions

Noticed when setting a language for a suggested project that my browser suggestion covered the app suggestion, anyone else have this? If so what we do?

User email validation

Ensure users have a valid email address, also need to clean up old users with invalid email addresses.

Footer

Basic footer with twitter link and sponsor logos.

Add language to suggested projects in emails

Similar to the _project.html.haml partial

Browse all users involved

You can't see everyone who has signed up, should be a paginated list at /users linked from the homepage

Language validation

I suggest, that we should add programming language validation to project model, or we will have problem when user adds non-supported or mistyped languages.

Fix inuit.css GH repo url

At the moment this one points to: http://github.com/csswizandry/inuit.css

Can this be changed to: https://github.com/csswizardry/inuit.css ?
The one used at the moment in the site results in a 404 and to be consistent with the rest of the project url's, the provided change also points to the secure version

Add a twitter "tweet" button

Set up an irc room

So people can discuss pull requests etc with others also involved.

Add details to about page and maybe dashboard as well.

Project URL bug

I couldn’t get a direct link, so there are some steps to reproduce:

• Open the projects list.
• Select “Shell” section.

There is only one project named “s” which has wrong URL: 24pullrequests.com/github.com/grobertson/s instead of github.com/grobertson/s.

I don’t know Ruby well, so I couldn’t send a pull request, but probably there is some trouble with a GitHub link validation on the project suggestion form.

Add a list of dependencies to readme

For people new to the project (and maybe even rails), we should make it clear that the project requires ruby 1.9.3, postgres and some other things which are second nature to experienced ruby devs.

"Gifting" pull requests

Select one pull request per day to be your "gift" for the day.

• Optional gift message (default to comment from GH pull request).
• Only one gift per day, each pull req can only be used once
• Add a message to a users dashboard if they have not gifted anything for today

Display all gifts in an advent calendar style on the users public page.

Footer links messed up on mobile

Should probably just be below the logo

Multiple languages breaks filter

The "suggest a project" feature fails to tell the user that commas aren't allowed in the input for languages. When multiple languages are listed, the individual filters fail to find the projects.

What's on the roadmap / How can I help?

Hey Andrew,

I'd love to hack on this and help make it awesome. What's in the pipeline?

<3,
Connor