Contributing to uDevkit

👍 We are happy to learn that you want to contribute !

Thank you for making the embedded world a more attractive domain. Each commits make it simpler.

This little guide goals to help you to contribute to this project.

Before contributing, never forget the following points:

How Can I Contribute?

Use past tense: Updated funtion getSensor
Include the part of project modified between square brackets.
- [project] msg For a modification inside project model

no tab, only spaces, 4 spaces
headers files with .h extension, .cpp for code files
class name start with a capital and are in camel case style
private and protected members start with an underscore and a lowercase, camel case style
getters have the same name than the member without the underscore
setters start by set followed by the member name with a capital

example, projectloader.h:

class ProjectLoader
{
public:
	ProjectLoader();

	const QString &path() const;
	void setPath(const QString &path);

protected:
	QString _path;
};