Contributing

Contributing

This page covers how to contribute to Flock.

Table Of Contents

• Overview
• Process
• Sprints
• Testing

Overview

Flock is completely Open Source and is licensed under the MIT License.

We encourage you to get involved in the Flock project.

Flock uses the GitHub Flow software development process.

Additionally ZenHub is used to augment standard GitHub issues.

Process

First features are designed on the Wiki via specification documents.

Next issues are created describing the work that must be completed to implement a feature.

Then these issues are planned into a weekly sprint and assigned to developers.

As the work for each of these issues is completed pull requests are opened. Code from this pull request is deployed to a staging environment.

These pull requests are reviewed and merged into master.

Changes merged into master are automatically tested and then deployed.

Sprints

A lite form of Agile development is used to manage work.

ZenHub issue estimates and boards are used to plan work.

Sprints have a length of 1 week. At the end of each week the next sprint is planned.

Testing

Flock uses a "push on green" philosophy when it comes to deployment.

This means that once all tests have passed the code is considered ready for deployment.

For this model to work all components of Flock must be completely tested. This includes unit tests and integration tests.

All pull requests must include tests for the changes being introduced.