Skip to content

Monthly Bug Squash Day

Aleks-Daniel Jakimenko-Aleksejev edited this page Mar 26, 2020 · 279 revisions

Every first Saturday of a month is a Bug Squash Day 🐞🔨 (a.k.a. Community Bug SQUASHathon). This falls approximately between rakudo release dates, so everyone is expected to hang around on #raku channel and have fun. Each month a repository is chosen, and the goal is to resolve as many bugs as possible in that repository.

Prizes

  • Every squashathon contributor gets free virtual pizza!
  • One person that makes most/best contributions (e.g. Pull Requests) for the Squashathon will receive a plush camelia. A real, physical one!

plush camelia
(album)

Dates

Date Repository How to contribute Before Result
2019-08-03 Documentation proofreading and rest of doc issues How to
participate
283 28 pages proofread
Winner: uzluisf
2019-09-07 Documenting Red, the Raku 6 ORM. Issues are documented here How to contribute 165 issues Stats
Winner: @Xliff
2019-10-19 testneeded
(tickets)
perl6/roast
rakudo/rakudo
How to contribute, CONTRIBUTING.md
CONTRIBUTING.md
62 tickets Stats
Winner:
@Altai-man
(with 7 pull requests!)
2019-11-01 No squashathon this month, take care of yourself!
2019-12-07 Raku FAQ GUIDE N/A Stats
Winner:
@MasterDuke17
2020-01-01 No squashathon this month. Happy New Year! 🎉
2020-02-08 old-issue-tracker README 1272 tickets updated tickets
log and stats
🍕🍕🍕🍕🍕
2020-03-01
🍕🍕🍕🍕🍕
No squashathon this month. Just go and have fun! 🥳
🍕🍕🍕🍕🍕
2020-04-01
🍕🍕🍕🍕🍕
No squashathon this month. Stay home and take care!

ᵃ – (optimistic) the number of commits can be over-estimated due to branch synchronizations
ᵇ – (pessimistic) only shows the number of people who interacted with one of the tracked repos on GitHub; interactions with RT are not included
ᶜ – (optimistic) may include unrelated progress
ᵈ – (pessimistic) does not include progress right before or right after the squashathon
ᵉ – (optimistic) includes progress done by others (before the squashathon) that was merely documented

Old squashathons are moved to this other page.

Recommendations

During the day keep an eye on #raku channel and try to help others. Some people will likely be contributing to the chosen repo for the first time, so be ready to guide them. While doing that, see if CONTRIBUTING docs can be improved to make the process easier.

When contributing yourself, try to focus on resolving bugs. Comments and other progress on RFCs and feature requests is welcome too, but the primary goal of the event is to reduce the amount of technical debt, not increase it. Therefore, refrain from implementing completely new things. Mostly this does not apply to perl6/roast or perl6/doc repos (more tests and more documentation is exactly what we want).

If you don't have push access to the repo, ask for a commit bit on #raku channel. However, contributing to rakudo requires signing a CLA, so use Pull Requests instead during the months when Rakudo is being SQUASHathoned.

When you start working on some github issue, please self-assign yourself to make sure that no work is wasted.

During the day things may be going fast, don't let that make you rush. When in doubt, ask others to review. Usually this means that you can just leave a comment with whatever you have on your mind and move on to the next ticket.

If you spot any issues, feel free to file new bug reports. We will count the number of resolved issues separately from the total number of open tickets, so it's OK if it happens that we end up with more open tickets by the end of the day.

When you come across an old ticket that is unclear or unnecessarily overloaded, be bold. If you don't understand what is requested, write a comment asking what exactly should be done to resolve the issue. Ping or assign people who may know more about it. If possible, come up with a crude solution and ask what further improvements should be done to close the ticket.

If the ticket is asking for more than one thing, replace with new smaller tickets and close it. If you see a lot of out-of-place discussion, try to understand the main point and create a new highly-specific ticket to replace it.

Notes

In October, Hacktoberfest and SQUASHathon happen at the same time, so people participating in SQUASHathon are also hacktoberfesting.