Skip to content

Latest commit

 

History

History
43 lines (25 loc) · 1.77 KB

CONTRIBUTING.md

File metadata and controls

43 lines (25 loc) · 1.77 KB

Contributing

Types of contribution

Three main ways to contribute to this project are;

  • Adding a new feature: Adding a new feature to the project, such as allow encoding of audio files alongside images
  • Improving a feature: Extend/improve an existing feature, such as a small UI change
  • Fix an issue: We have a list of issues, or you can fix your own issue.

Note: Please do the following when raising a MR

  • Raise an issue before creating an MR
  • Fork the project
  • Name the branch after the issue number you are fixing i.e. feature/#105
  • Raise an MR from the feature branch to the master branch (never to the production branch)

Releases

You can view the project milestones, to see the up coming releases for the application. Issues will be tied to milestones and completed within that milestone.

You can also see what issues are currently being worked on by visiting the kanban board.

Note: There should be a kanban board for each release (milestone).

Commit Message

If you can try to a detailed commit message about what the change is doing. Don't worry about multiple commits they will be squashed (and rebased) into a single commit.

Getting Started

You can get more information here about how to setup your own development environment.

Licensing

Please note that the examples are all made available under the Apache License 2.0,

Getting help

If you need any help please free feel to get in contact with me.