Contribution Guide

We welcome contributions from external contributors, and this document describes how to merge code changes into VoteM8.

Getting Started

1. Make sure you have a GitHub account.

2. Fork this repository on Github.

3. On your local machine, clone your fork of the repository.

Making Changes

1. Add some changes to your local fork. It’s usually a good idea to make changes on a branch with the branch name relating to the feature you are going to add.

2. If you’re providing a new feature, you must add documentation and ideally test cases.

3. When you are ready for others to examine and comment on your new feature, navigate to your fork of VoteM8 on GitLab and open a Merge Request (MR). Note that after you launch a MR from one of your fork’s branches, all subsequent commits to that branch will be added to the open pull request automatically. Each commit added to the MR will be validated for mergability, the results of these tests will be visible on the MR page.

4. When you believe the MR has reached its final draft, check the “Ready to go” box below to let the VoteM8 devs know that the changes are complete. The code will not be considered for merging until this box is checked and multiple core developers give “Approved” reviews.