Skip to content
Jim Cowart edited this page Jan 16, 2013 · 3 revisions

postal.federation is pretty young, and actively maintained. If you're interested in contributing, the best way to start is by forking the repository and submitting pull requests. Here are some things to keep in mind:

  • If you open an issue, please provide clear steps on how to reproduce the problem. Protip: a failing test will get moved to the front of the line.
  • If you submit a pull request, please make sure you have added test coverage of your changes/additions as well, otherwise, the PR will be rejected outright. postal.federation is using mocha + expect.js.
  • For postal.federation source:
    • we are following a convention of actual tabs for indentation (we display those tabs at the equivalent of 4 spaces - you can display them however you want, as long as your indentation has actual tabs).
    • for spacing on a line (after indentation), we are using actual spaces
  • Roadmap:
    • machina will most likely become a dependency soon, as it's easier to model certain aspects of federation with finite state machines
Clone this wiki locally