Skip to content

Latest commit

 

History

History
30 lines (21 loc) · 1.8 KB

CONTRIBUTING.md

File metadata and controls

30 lines (21 loc) · 1.8 KB
Raw

You are welcome and encouraged to contribute.

Show Interest

We ask that you let us know you are interested in the project by

  • emailing [email protected]
  • joining the gitter chat and saying hi. https://gitter.im/voluntarily/community
  • If you are in Auckland NZ then visit us on Drop in Wednesdays at 48 Emily Place.
  • please sign up for one of our working bees or hacker events - see voluntarily.nz home page for details.
    • we will have regular events in Auckland, Wellington, Christchurch and other locations.
  • Talk to your employers about support the project with developer volunteer days.

Contribute

You can fork the code and submit a pull request but we would prefer you to join the team and work on branches in the main repository.

To do this please first complete https://voluntarily.atlassian.net/browse/VP-82 As a developer I can check out the code base, build and run it, and make a simple change Adding your name to the CONTRIBUTORS File indicates that you are submitting your code changes to the project under the open source licence MPL-2.0

Then ask in Gitter for a suitable Jira ticket to work on. It is always ok to increase test coverage and we encourage everyone to write automated tests to help understand the code base, find bugs and increase overall quality.

Work on a (short lived) branch labelled with the Jira ticket id e.g. task/VP-82/contributing. Submit a PR and we will endeavour to merge within a day. After your first commit we will add you to the GitHub Team so that you can branch within the project.

Architecture, Requirements and Guidelines

These are all in the Wiki. https://voluntarily.atlassian.net/wiki/spaces/VP/overview

Please read the non functional requirements and values pages.

All features must be secure, accessible, usable and maintain personal privacy.