Before reading on, please see Internal Design to get an idea of what things go where. After that, you might want to take a look at some of the more detailed documents in the docs/hacking/ directory.
To contribute code, you will want to be familiar with both the NQP and PIR languages; though over time, PIR expertise will become less important as we replace old PIR code with NQP. Metadata is stored in JSON format which is fairly easy to understand but Parrot's JSON parser is currently rather picky so it helps to be pedantic if it's whining at you.
Don't worry, there aren't many.
Fundamentally, our committer rules boil down to the same ones Parrot uses:
- Don't break the build.
- Increase the awesome.
Many thanks to chromatic for suggesting these.
Our coding conventions and guidelines are the same as those used by the Parrot project.
They can be viewed at http://docs.parrot.org/parrot/latest/html/docs/pdds/pdd07_codingstd.pod.html.
Please do your best to follow them; we want our code to be clean and consistent.
If you have any questions,
feel free to ask on
Commit bits are given freely to those who have sent in a signed CLA to the Parrot project; just ping japhb on
irc.parrot.org and ask.
You are welcome to clone the Git repository and send patches - one of us will review them and commit or reply with comments.
With your first patch or commit, please add yourself to the CREDITS file.
Welcome to the Plumage team. We're happy to have you!