2020-11-11 14:36:38 -05:00
|
|
|
Contributing to GNU Stow
|
|
|
|
|
========================
|
|
|
|
|
|
|
|
|
|
Development of Stow, and GNU in general, is a volunteer effort, and
|
|
|
|
|
you can contribute. If you'd like to get involved, it's a good idea to join
|
|
|
|
|
the [stow-devel](https://lists.gnu.org/mailman/listinfo/stow-devel)
|
|
|
|
|
mailing list.
|
|
|
|
|
|
|
|
|
|
Bug reporting
|
|
|
|
|
-------------
|
|
|
|
|
|
|
|
|
|
Please follow the procedure described in [the "Reporting Bugs"
|
|
|
|
|
section](https://www.gnu.org/software/stow/manual/html_node/Reporting-Bugs.html#Reporting-Bugs)
|
|
|
|
|
of [the manual](README.md#documentation).
|
|
|
|
|
|
|
|
|
|
Development
|
|
|
|
|
-----------
|
|
|
|
|
|
|
|
|
|
For [development sources](https://savannah.gnu.org/git/?group=stow)
|
|
|
|
|
and other information, please see the [Stow project
|
|
|
|
|
page](http://savannah.gnu.org/projects/stow/) at
|
|
|
|
|
[savannah.gnu.org](http://savannah.gnu.org).
|
|
|
|
|
|
|
|
|
|
There is also a
|
|
|
|
|
[stow-devel](https://lists.gnu.org/mailman/listinfo/stow-devel)
|
|
|
|
|
mailing list (see [Mailing lists](README.md#mailing-lists)).
|
|
|
|
|
|
2020-11-11 14:41:38 -05:00
|
|
|
Testing
|
|
|
|
|
~~~~~~~
|
|
|
|
|
|
|
|
|
|
The test suite can be found in the [`t/`](t/) subdirectory. You can
|
|
|
|
|
run the test suite via:
|
|
|
|
|
|
|
|
|
|
make check
|
|
|
|
|
|
2021-04-04 13:10:17 -04:00
|
|
|
Tests can be run individually as follows. First you have to ensure
|
|
|
|
|
that the `t/`, `bin/`, and `lib/` directories are on Perl's search path.
|
|
|
|
|
Assuming that you run all tests from the root of the repository tree,
|
|
|
|
|
this will do the job:
|
2020-11-11 14:41:38 -05:00
|
|
|
|
2021-04-04 13:10:17 -04:00
|
|
|
export PERL5LIB=t:bin:lib
|
|
|
|
|
|
|
|
|
|
(Not all tests require all of these, but it's safer to include all of
|
|
|
|
|
them.)
|
|
|
|
|
|
|
|
|
|
Now running an individual test is as simple as:
|
|
|
|
|
|
|
|
|
|
perl t/chkstow.t
|
2020-11-11 14:41:38 -05:00
|
|
|
|
|
|
|
|
or with a given debugging verbosity corresponding to the `-v` / `--verbose`
|
|
|
|
|
command-line option:
|
|
|
|
|
|
2021-04-04 13:10:17 -04:00
|
|
|
TEST_VERBOSE=4 perl t/chkstow.t
|
|
|
|
|
|
|
|
|
|
The [`prove(1)` test runner](https://perldoc.perl.org/prove) is another
|
|
|
|
|
good alternative which provides several handy extra features. Invocation
|
|
|
|
|
is very similar, e.g.:
|
|
|
|
|
|
|
|
|
|
prove t/stow.t
|
|
|
|
|
|
|
|
|
|
or to run the whole suite:
|
|
|
|
|
|
|
|
|
|
prove
|
2020-11-11 14:41:38 -05:00
|
|
|
|
2020-11-11 14:36:38 -05:00
|
|
|
Translating Stow
|
|
|
|
|
----------------
|
|
|
|
|
|
|
|
|
|
Stow is not currently multi-lingual, but patches would be very
|
|
|
|
|
gratefully accepted. Please e-mail
|
|
|
|
|
[stow-devel](https://lists.gnu.org/mailman/listinfo/stow-devel) if you
|
|
|
|
|
intend to work on this.
|
|
|
|
|
|
|
|
|
|
Maintainers
|
|
|
|
|
-----------
|
|
|
|
|
|
|
|
|
|
Stow is currently being maintained by Adam Spiers. Please use [the
|
|
|
|
|
mailing lists](README.md#mailing-lists).
|
|
|
|
|
|
|
|
|
|
Helping the GNU project
|
|
|
|
|
-----------------------
|
|
|
|
|
|
|
|
|
|
For more general information, please read [How to help
|
|
|
|
|
GNU](https://www.gnu.org/help/).
|
