Skip to content

Commit 5a8f5aa

Browse files
committed
Adds squashaton rules closes #1987
1 parent a608afe commit 5a8f5aa

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ in the [#perl6 IRC channel](https://perl6.org/community/irc).
4242
* Be explicit about routine signatures. If a method accepts a `*%args`,
4343
but treats some of them specially, list them separately.
4444
* Check out [the styleguide](writing-docs/STYLEGUIDE.md) for further guidance.
45+
* If you are participating in one of the montly squashathons, [please read this guide](writing-docs/SQUASHATHONS.md).
4546

4647
## Writing Code Examples
4748

writing-docs/SQUASHATONS.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Squashathon HOWTO
2+
3+
[SQUASHathons](https://github.com/rakudo/rakudo/wiki/Monthly-Bug-Squash-Day) happen monthly in the Perl 6 community, with every other one devoted to this repository. It will help the organization of the hackathon if you follow these rules when participating in it.
4+
5+
1. Always work against an issue. If you find some typo or any other kind of error for which an issue does not exist, please create one.
6+
2. Always work on assigned issues. Assignments get echoed in the [`perl6` IRC channel](https://webchat.freenode.net/?channels=#perl6), so everyone knows someone is working on that.
7+
3. You can only assign issues to contributors, so if someone who is not a contributor asks to be assigned something to a contributor, please assign it to yourself and do an `@` mention in the issue to the person that is actually doing the work.
8+
4. Please leave the [good first issues](https://github.com/perl6/doc/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) until the end of the hackathon; if you find something that can be solved easily in the first hours, please tag it that way and leave it until the end.
9+

0 commit comments

Comments
 (0)