[p5sagit/Devel-OverrideGlobalRequire.git] / CONTRIBUTING

CONTRIBUTING

Thank you for considering contributing to this distribution.  This file
contains instructions that will help you work with the source code.

The distribution is managed with Dist::Zilla.  This means than many of the
usual files you might expect are not in the repository, but are generated
at release time (e.g. Makefile.PL).

However, you can run tests directly using the 'prove' tool:

  $ prove -l
  $ prove -lv t/some_test_file.t

For most distributions, 'prove' is entirely sufficent for you to test any
patches you have.

You may need to satisfy some dependencies.  See the included META.json
file for a list.  If you install App::mymeta_requires from CPAN, it's easy
to satisfy any that you are missing by piping the output to your favorite
CPAN client:

  $ mymeta-requires | cpanm
  $ cpan `mymeta-requires`

Likewise, much of the documentation Pod is generated at release time.
Depending on the distribution, some documentation may be written in a Pod
dialect called WikiDoc. (See Pod::WikiDoc on CPAN.) If you would like to
submit a documentation edit, please limit yourself to the documentation you
see.

If you see typos or documentation issues in the generated docs, please
email or open a bug ticket instead of patching.

Dist::Zilla is a very powerful authoring tool, but requires a number of
author-specific plugins.  If you would like to use it for contributing,
install it from CPAN, then run one of the following commands, depending on
your CPAN client:

  $ cpan `dzil authordeps`
  $ dzil authordeps | cpanm

Once installed, here are some dzil commands you might try:

  $ dzil build
  $ dzil test
  $ dzil xtest

You can learn more about Dist::Zilla at http://dzil.org/
Commit	Line	Data
1a80b58a	1	CONTRIBUTING
	2
	3	Thank you for considering contributing to this distribution. This file
	4	contains instructions that will help you work with the source code.
	5
	6	The distribution is managed with Dist::Zilla. This means than many of the
	7	usual files you might expect are not in the repository, but are generated
	8	at release time (e.g. Makefile.PL).
	9
	10	However, you can run tests directly using the 'prove' tool:
	11
	12	$ prove -l
	13	$ prove -lv t/some_test_file.t
	14
	15	For most distributions, 'prove' is entirely sufficent for you to test any
	16	patches you have.
	17
	18	You may need to satisfy some dependencies. See the included META.json
	19	file for a list. If you install App::mymeta_requires from CPAN, it's easy
	20	to satisfy any that you are missing by piping the output to your favorite
	21	CPAN client:
	22
	23	$ mymeta-requires \| cpanm
	24	$ cpan `mymeta-requires`
	25
	26	Likewise, much of the documentation Pod is generated at release time.
	27	Depending on the distribution, some documentation may be written in a Pod
	28	dialect called WikiDoc. (See Pod::WikiDoc on CPAN.) If you would like to
	29	submit a documentation edit, please limit yourself to the documentation you
	30	see.
	31
	32	If you see typos or documentation issues in the generated docs, please
	33	email or open a bug ticket instead of patching.
	34
	35	Dist::Zilla is a very powerful authoring tool, but requires a number of
	36	author-specific plugins. If you would like to use it for contributing,
	37	install it from CPAN, then run one of the following commands, depending on
	38	your CPAN client:
	39
	40	$ cpan `dzil authordeps`
	41	$ dzil authordeps \| cpanm
	42
	43	Once installed, here are some dzil commands you might try:
	44
	45	$ dzil build
	46	$ dzil test
	47	$ dzil xtest
	48
	49	You can learn more about Dist::Zilla at http://dzil.org/
	50