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
37
38
39
40
41
42
43
44
45
46
47
48
|
# Contributing to the development of PDF::Table
**Working on your first Pull Request?** You can learn how from this *free* series [How to Contribute to an Open Source Project on GitHub](https://kcd.im/pull-request)
We would appreciate the community around us chipping in with code, tests,
documentation, and even just bug reports and feature requests. It's better
knowing what users of PDF::Table want and need, than for us to guess. It's
not good to spend a lot of time working on something that no one is interested
in!
You can contribute to the discussion by posting bug reports, feature requests,
observations, etc. to the [GitHub issues area](https://github.com/PhilterPaper/PDF-Table/issues?q=is%3Aissue+sort%3Aupdated-desc "issues")
(please tag new threads accordingly, using ["Labels"], if possible).
For code changes, a GitHub pull request, a formal patch file (e.g., "diff"), or
even a replacement file or manual patch will do, so long as it's clear where it
goes and what it does. If the volume of such work becomes excessive (i.e., a
burden to us), we reserve the right to limit the ways that code changes can be
submitted. At this point, the volume is low enough that almost anything can be
handled. Please DO NOT send us code changes "out of the blue" (without prior
discussion), unless they are very small, so that you're not out a lot of
effort if we decline the offer.
## Do NOT...
Do NOT under ANY circumstances open a PR (Pull Request) to **report a _bug_.**
It is a waste of both _your_ and _our_ time and effort. Instead, simply open a
regular ticket (_issue_) in GitHub, and attach a Perl (.pl) program that
illustrates the problem, if possible.
If you believe that you have a program patch (i.e., a permanent change to the
code), and offer to share it as a PR, we may give the go-ahead. Unsolicited PRs
may be closed without further action.
Please do not start on a massive project (especially, new function), without
discussing it with us first (via email or one of the discussion areas). This
will save you the disappointment of seeing your hard work rejected because it
doesn't fit in with what's going on with the rest of the PDF::Table project.
You are free to try contributing anything you want, or even to fork the project
if you don't like the direction it's taking. Keeping in touch and coordinating
with us ensures that your work won't be wasted. If you have something dependent
on PDF::Table functionality, but it doesn't fit our roadmap for core
functionality, we may suggest that you release it as a separate package on CPAN
(dependent on PDF::Table), or as a new sub-package to be under PDF::Table (e.g.,
like PDF::API2::Ladder), under either our ownership or yours.
Good luck, and best wishes using and helping with PDF::Table!
May, 2023
|
