Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 70 lines (46 sloc) 2.406 kb
99b9b7b Michael G. Schwern Add a patching policy
schwern authored
1 Patching policy for perl5i.
2
992c266 Michael G. Schwern Encourage patching.
schwern authored
3 For the really impatient:
4 -------------------------
5
6 * Rule 1: When in doubt, open a ticket.
7 http://github.com/schwern/perl5i/issues
8
9 Found a bug? Not sure if its a bug or a weird feature? Have an idea?
10 Found something unpleasent? Had trouble using something? Open a ticket.
11 Don't worry, we won't yell at you. We'd rather get 10 duplicates than
12 lose one good report because somebody wasn't sure.
13
14 * We prefer if you use github, but you can always email a patch
15 to perl5i@googlegroups.com.
16
17 * Don't know if your code is up to our standard? Send it in and
18 we'll work it out.
19
20 * perl5i is about making Perl 5 better. A good rule of thumb is if
21 it takes more than one line to do a simple thing, you might be on to
22 something. If a newbie asks a simple question and the "right answer"
23 takes a full page, you've probably found a candidate for perl5i.
24
25
26 Here's the preferred way to make a patch:
27 ----------------------------------------
28
29 0) We'd rather you participate than follow all the rules, especially
30 if its your first patch. Don't worry, be crappy.
99b9b7b Michael G. Schwern Add a patching policy
schwern authored
31
32 1) Put an issue in the tracker for your problem. Then it can be
33 discussed before you put a whole lot of effort into it.
34 http://github.com/schwern/perl5i/issues
35
36 1a) If its a bug, report the bug BEFORE work on it. This ensures the
37 bug gets reported. Mention that you're working on it.
38
39 1b) If its a feature, we like to hear about your idea even if
40 you don't have a patch.
41
42 2) You can either work from the CPAN version or the repository.
43 We'd prefer you worked from the repository.
44 http://github.com/schwern/perl5i
45
46 2a) Ideally, make a fork on github and work on that.
47
48 3) DO add any new dependencies in Build.PL
49
3dbf805 Michael G. Schwern Some updates to the patching policy
schwern authored
50 3a) If you're not sure what version to depend on, pick the version
51 you have installed. That's safest.
52
99b9b7b Michael G. Schwern Add a patching policy
schwern authored
53 4) DON'T update MANIFEST. Its automated and will just cause
54 conflicts.
55
56 5) DON'T update Changes. It will cause conflicts when merging.
57 The release manager will handle it.
58
3dbf805 Michael G. Schwern Some updates to the patching policy
schwern authored
59 6) DO write tests. Otherwise the release manager has to.
60
61 7) DO write documentation. Otherwise the release manager has to.
99b9b7b Michael G. Schwern Add a patching policy
schwern authored
62
3dbf805 Michael G. Schwern Some updates to the patching policy
schwern authored
63 8) Commit ONE THING AT A TIME. Preferrably use a branch for each
64 feature. It makes it much easier to integrate.
99b9b7b Michael G. Schwern Add a patching policy
schwern authored
65
3dbf805 Michael G. Schwern Some updates to the patching policy
schwern authored
66 9) You can either send patches to schwern+perl5i@pobox.com or
99b9b7b Michael G. Schwern Add a patching policy
schwern authored
67 (preferred) issue a github pull request.
68
69 Thanks for patching!
Something went wrong with that request. Please try again.