Personal tools

Diagrams/Contributing

From HaskellWiki

< Diagrams
Revision as of 14:00, 31 July 2012 by Byorgey (Talk | contribs)

Jump to: navigation, search

This page is under construction -- please help!

Contents

1 Getting involved

There are two major ways to get involved in the diagrams community and find out what is going on:

  • The IRC channel (#diagrams on freenode.org) is fairly active and a good place to interact with other diagrams users and developers. (Be patient: sometimes no one is watching the channel, but if you say something or ask a question, you can be sure that someone will eventually see it and respond.)
  • The mailing list is the place to stay up-to-date with announcements, and also a good place to ask questions, especially longer or more involved ones.

2 Getting the sources

All the core diagrams code can be found in the diagrams organization on github.

If you don't already know how to work with repositories hosted on github, we recommend XXX. Also, see the walkthrough example below.

3 Choosing a project

  • bug tracker
  • projects page
  • ask on mailing list or IRC

4 Best practices

XXX walk through example of checking out repo, making and committing changes, and submitting a pull request. Show how to do it manually and also using 'hub' utility.

  • use topic branches
  • encourage submitting update to documentation
  • link to coding style document