Skip to content

Commit f307872

Browse files
committed
CONTRIBUTING.md + some README.md changes
1 parent 5ca2ac8 commit f307872

File tree

2 files changed

+69
-2
lines changed

2 files changed

+69
-2
lines changed

CONTRIBUTING.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
## How to contribute to Whateverable
2+
3+
🍕 First off, thanks for taking the time to contribute! 🍕
4+
5+
6+
If you have a question that is not covered here, just
7+
talk to a human on
8+
[#perl6 or #whateverable](https://webchat.freenode.net/?channels=#perl6,#whateverable)
9+
IRC channel on freenode.
10+
11+
12+
Looking for a bug to squash? See
13+
[issues marked as low-hanging fruit](https://github.com/perl6/whateverable/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22).
14+
15+
16+
### Reporting bugs
17+
18+
If you found a bug, feel free to
19+
[file an issue](https://github.com/perl6/whateverable/issues/new).
20+
Include as much information as you feel necessary.
21+
22+
Note that issues are only closed once there is a fix *and* at least
23+
one test. Tickets that need tests are marked with
24+
[`testneeded`](https://github.com/perl6/whateverable/issues?q=is%3Aissue+is%3Aopen+label%3Atestneeded)
25+
label.
26+
27+
28+
### Submitting changes
29+
30+
Generally, code contributions are accepted as
31+
[pull requests](https://help.github.com/articles/about-pull-requests/).
32+
Let us know if that is not suitable for you and you want to contribute
33+
in a different way (e.g. by mailing a patch).
34+
35+
To test your changes, check out
36+
[wiki/Installation](https://github.com/perl6/whateverable/wiki/Installation)
37+
for instructions on installing and running the bots.
38+
39+
Coding conventions are not enforced, but try to keep your changes
40+
consistent with code around them. For example, you'll find that
41+
unicode quotes (`“”`, `‘’`, `「」`) are preferred over ASCII quotes
42+
(`""`, `''`), but pull requests will be accepted regardless of which
43+
quotes are used. The code will be consistified later in bulk.
44+
45+
46+
### Do you want more information about the bots?
47+
48+
If you want to learn more about the functionality of the bots, please
49+
see [whateverable wiki](https://github.com/perl6/whateverable/wiki).

README.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,23 @@
1-
## Usage
1+
## Whateverable
2+
3+
The Whateverables are a collection of IRC bots primarily useful for
4+
Perl 6 developers. They are written in Perl 6 and are based on
5+
[IRC::Client](https://github.com/zoffixznet/perl6-IRC-Client). Many of
6+
the use cases involve running Perl 6 code using pre-built versions of
7+
the [Rakudo](https://github.com/rakudo/rakudo) Perl 6 compiler for
8+
each commit.
9+
10+
11+
### Usage
12+
213
See [wiki](https://github.com/perl6/whateverable/wiki) for more information.
314

4-
## Installation
15+
16+
### Contributing
17+
18+
See [CONTRIBUTING.md](CONTRIBUTING.md).
19+
20+
21+
### Installation
22+
523
See [wiki/installation](https://github.com/perl6/whateverable/wiki/Installation).

0 commit comments

Comments
 (0)