Permalink
Browse files

CONTRIBUTING.md + some README.md changes

  • Loading branch information...
AlexDaniel committed May 29, 2018
1 parent 5ca2ac8 commit f307872bc81adcfa5e07f47665e62ee921aaa4a3
Showing with 69 additions and 2 deletions.
  1. +49 −0 CONTRIBUTING.md
  2. +20 −2 README.md
View
@@ -0,0 +1,49 @@
## How to contribute to Whateverable
🍕 First off, thanks for taking the time to contribute! 🍕
If you have a question that is not covered here, just
talk to a human on
[#perl6 or #whateverable](https://webchat.freenode.net/?channels=#perl6,#whateverable)
IRC channel on freenode.
Looking for a bug to squash? See
[issues marked as low-hanging fruit](https://github.com/perl6/whateverable/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22).
### Reporting bugs
If you found a bug, feel free to
[file an issue](https://github.com/perl6/whateverable/issues/new).
Include as much information as you feel necessary.
Note that issues are only closed once there is a fix *and* at least
one test. Tickets that need tests are marked with
[`testneeded`](https://github.com/perl6/whateverable/issues?q=is%3Aissue+is%3Aopen+label%3Atestneeded)
label.
### Submitting changes
Generally, code contributions are accepted as
[pull requests](https://help.github.com/articles/about-pull-requests/).
Let us know if that is not suitable for you and you want to contribute
in a different way (e.g. by mailing a patch).
To test your changes, check out
[wiki/Installation](https://github.com/perl6/whateverable/wiki/Installation)
for instructions on installing and running the bots.
Coding conventions are not enforced, but try to keep your changes
consistent with code around them. For example, you'll find that
unicode quotes (`“”`, `‘’`, `「」`) are preferred over ASCII quotes
(`""`, `''`), but pull requests will be accepted regardless of which
quotes are used. The code will be consistified later in bulk.
### Do you want more information about the bots?
If you want to learn more about the functionality of the bots, please
see [whateverable wiki](https://github.com/perl6/whateverable/wiki).
View
@@ -1,5 +1,23 @@
## Usage
## Whateverable
The Whateverables are a collection of IRC bots primarily useful for
Perl 6 developers. They are written in Perl 6 and are based on
[IRC::Client](https://github.com/zoffixznet/perl6-IRC-Client). Many of
the use cases involve running Perl 6 code using pre-built versions of
the [Rakudo](https://github.com/rakudo/rakudo) Perl 6 compiler for
each commit.
### Usage
See [wiki](https://github.com/perl6/whateverable/wiki) for more information.
## Installation
### Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md).
### Installation
See [wiki/installation](https://github.com/perl6/whateverable/wiki/Installation).

0 comments on commit f307872

Please sign in to comment.