Contributing To ff7tk

ff7tk is an open source project and all open source projects need contributors. Thank you for taking the time to read this document and Thank you for your future contributions to the project.

Prerequisites

In order to contribute code to ff7tk you will need to have a Github account. You should also have git installed so you can pull and push code.

General Coding Guidelines

The following guidelines apply to all submited code.

• We mostly follow the KDE style guidelines
• Use constant references when possible
• Headers should use #pragma once.
• Auto should not be used if the type is not explicit.
• Doxygen comments should be created/updated with code.
• Objects should have logical variable and function names
• Code should always be readable, comment your code if its not clear what is going on.

Commit Guidelines

Keeping a clean project history requires that we take care when choosing how we will commit our code.Consider the following when creating commits.

• Consider the KDE commit guidelines.
• Pull Requests will be reviewed via Github
• Amend your local commits to fix any review issues.