1
+ ## Contributing
2
+
1
3
Your patches to perl6/doc are very welcome.
2
4
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.
5
7
6
8
If you have any questions regarding contributing to this project, please ask
7
9
in the [ #perl6 IRC channel] ( http://perl6.org/community/irc ) .
@@ -17,8 +19,21 @@ in the [#perl6 IRC channel](http://perl6.org/community/irc).
17
19
18
20
## Documenting types
19
21
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:
22
37
23
38
=TITLE role MyFunnyRole
24
39
@@ -130,6 +145,14 @@ package manager:
130
145
131
146
$ aptitude install pygmentize
132
147
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
+
133
156
Otherwise, you probably need to use [ ` pip ` ] ( https://pip.pypa.io/en/latest/ )
134
157
(the Python package installer):
135
158
0 commit comments