Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
added some more introductory information to CONTRIBUTING
  • Loading branch information
mkrull committed Feb 26, 2015
1 parent 0aa46b0 commit c2ded1a
Showing 1 changed file with 27 additions and 4 deletions.
31 changes: 27 additions & 4 deletions CONTRIBUTING.md
@@ -1,7 +1,9 @@
## Contributing

Your patches to perl6/doc are very welcome.

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

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

## Documenting types

Types should be documented like this (the tool `util/new-type.p6` can create
the skeleton for you):
The POD documentation of types is located in the `lib/Type` directory and
subdirectories of this repository. For example the POD of `X::Bind::Slice`
lives in `lib/Type/X/Bind/Slice.pod`.

To start contributing fork and checkout the repository, find the document
you want to improve, commit your changes, and create a pull request. Should
questions come up in the process feel free to ask in
[#perl6 IRC channel](http://perl6.org/community/irc).

If the documentation for a type does not exist create the skeleton of the doc
with the helper tool `util/new-type.p6`. Say you want to create `MyFunnyRole`:

$ perl6 util/new-type.p6 MyFunnyRole

Fill the documentation file `lib/Type/MyFunnyRole.pod` like this:

=TITLE role MyFunnyRole

Expand Down Expand Up @@ -130,6 +145,14 @@ package manager:

$ aptitude install pygmentize

On Ubuntu install the package python-pygments:

$ sudo apt-get install python-pygments

On Fedora the package is also named python-pygments:

$ sudo yum install python-pygments

Otherwise, you probably need to use [`pip`](https://pip.pypa.io/en/latest/)
(the Python package installer):

Expand Down

0 comments on commit c2ded1a

Please sign in to comment.