-
Notifications
You must be signed in to change notification settings - Fork 3
/
CONTRIBUTING
37 lines (31 loc) · 1.82 KB
/
CONTRIBUTING
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
Wow, you want to help? That's great!
I'll put together a more detailed version of this, but I'll point you in
some useful directions that could help with this module.
If you want to help:
* Don't break the public interface. You can add to it, but don't
break code that already depends on this interface.
* I'll take bug reports however you want to send them (RT, Github
issue, email, etc). My preference is for Github issues.
* I'll take code changes however you want to send them, but prefer
it via Github pull request.
* If you make suggestions/changes, I'll credit you unless you ask
specifically otherwise. I'll use your email and PAUSE ID (if
applicable) if I can find it. If I get this wrong or you change
either, just jot me a note or PR to change it.
Some things you can do that would make me smile:
* Feel free to look at the TODO file - I've pointed out some things I
want to do with the module. Feel free to do any of them (but if it
is a bigger item, you might jot me a note first so that I don't
accidentally duplicate your effort!)
* Write tests for things that are known to be broken (UTF-8 file
handling, for instance). Mark those as "todo" tests so that the
failures do not cause test failures.
* Improvements to documentation are always appreciated
* If the module is missing something you would find useful, or you're
confused about something, or if it doesn't seem to work the way you
want, email me or open a Github issue. The module makes sense to me
and my way of working, but if it doesn't to you, you probably are
not the only person who it doesn't make sense to.
* "Meta" stuff is great too - I'm no expert on Dist::Zilla and all
that it can/should do. So please feel free to send me suggestions
or PR for packaging, metafiles, etc