Skip to content

Commit c2ded1a

Browse files
committed
added some more introductory information to CONTRIBUTING
1 parent 0aa46b0 commit c2ded1a

File tree

1 file changed

+27
-4
lines changed

1 file changed

+27
-4
lines changed

CONTRIBUTING.md

Lines changed: 27 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
1+
## Contributing
2+
13
Your patches to perl6/doc are very welcome.
24

3-
They are even more welcome if you stick to our style and formatting
4-
guidelines.
5+
This document describes how to get started and helps to provide documentation
6+
that adheres to the common style and formatting guidelines.
57

68
If you have any questions regarding contributing to this project, please ask
79
in the [#perl6 IRC channel](http://perl6.org/community/irc).
@@ -17,8 +19,21 @@ in the [#perl6 IRC channel](http://perl6.org/community/irc).
1719

1820
## Documenting types
1921

20-
Types should be documented like this (the tool `util/new-type.p6` can create
21-
the skeleton for you):
22+
The POD documentation of types is located in the `lib/Type` directory and
23+
subdirectories of this repository. For example the POD of `X::Bind::Slice`
24+
lives in `lib/Type/X/Bind/Slice.pod`.
25+
26+
To start contributing fork and checkout the repository, find the document
27+
you want to improve, commit your changes, and create a pull request. Should
28+
questions come up in the process feel free to ask in
29+
[#perl6 IRC channel](http://perl6.org/community/irc).
30+
31+
If the documentation for a type does not exist create the skeleton of the doc
32+
with the helper tool `util/new-type.p6`. Say you want to create `MyFunnyRole`:
33+
34+
$ perl6 util/new-type.p6 MyFunnyRole
35+
36+
Fill the documentation file `lib/Type/MyFunnyRole.pod` like this:
2237

2338
=TITLE role MyFunnyRole
2439

@@ -130,6 +145,14 @@ package manager:
130145

131146
$ aptitude install pygmentize
132147

148+
On Ubuntu install the package python-pygments:
149+
150+
$ sudo apt-get install python-pygments
151+
152+
On Fedora the package is also named python-pygments:
153+
154+
$ sudo yum install python-pygments
155+
133156
Otherwise, you probably need to use [`pip`](https://pip.pypa.io/en/latest/)
134157
(the Python package installer):
135158

0 commit comments

Comments
 (0)