Skip to content
This repository has been archived by the owner on May 1, 2024. It is now read-only.

Latest commit

 

History

History
108 lines (66 loc) · 4.16 KB

CONTRIBUTING.md

File metadata and controls

108 lines (66 loc) · 4.16 KB

Contributing to QCFA

Thank you for your interest in QCFA and for taking the time to contribute to this project. 🙌 QCFA is a project by developers for developers and there are a lot of ways you can contribute.

Code of conduct

Contributors are expected to adhere to the Code of Conduct.

Prerequisites for the contributors

Contributors should have knowledge of C++, Arduino and git since the project work heavily depends on them. We encourage Contributors to set up QCFA for local development and play around with the code and tests to get more comfortable with the project.

General Contribution Flow

Signing-off on Commits (Developer Certificate of Origin)

To contribute to this project, you must agree to the Developer Certificate of Origin (DCO) for each commit you make. The DCO is a simple statement that you, as a contributor, have the legal right to make the contribution.

See the DCO file for the full text of what you must agree to and how it works here. To signify that you agree to the DCO for contributions, you simply add a line to each of your git commit messages:

Signed-off-by: John Smith <[email protected]>

In most cases, you can add this signoff to your commit automatically with the -s or --signoff flag to git commit. You must use your real name and a reachable email address (sorry, no pseudonyms or anonymous contributions). An example of signing off on a commit:

$ commit -s -m “my commit message w/signoff”

To ensure all your commits are signed, you may choose to add this alias to your global .gitconfig:

~/.gitconfig

[alias]
  amend = commit -s --amend
  cm = commit -s -m
  commit = commit -s

How to contribute ?

We encourage contributions from the community.

Create a GitHub issue for any changes beyond typos and small fixes.

We review GitHub issues and PRs on a regular schedule.

To ensure that each change is relevant and properly peer reviewed, please adhere to best practices for open-source contributions. This means that you must fork the repository and create PRs from branches on your own fork. The README in GitHub's first-contributions repo provides an example.

How to set up the docs website locally?

  1. Fork the repository

  1. Clone the repository with the following command. Replace the <GITHUB_USERNAME> with your username
git clone https://github.com/<GITHUB_USERNAME>/QCFA.git

  1. Go into the directory containing the project and edit the changes.

QCFA Contribution Flow

QCFA is written in C++ (C plus plus) and leverages C libraries. Please follow these relevant coding style guidelines:

  1. Use 2 spaces for indentations.

  2. Use /**/ instead of // for comments.

  3. Use _ for spaces in variables and functions names.

  4. Declare variables in the lowest scope possible.

  5. write #include <Arduino.h> at the beginning of each file.

  6. The usage of platformIO is recommended.

There are many ways in which you can contribute to QCFA.

Report a Bug

Report all issues through GitHub Issues using the Report a Bug template. To help resolve your issue as quickly as possible, read the template and provide all the requested information.

Feature request

We welcome all feature requests, whether it's to add new functionality to an existing extension or to offer an idea for a brand new extension. File your feature request through GitHub Issues using the Feature Request template.

Close a Bug

We welcome contributions that help make QCFA bug free & improve the experience of our users. You can also find issues tagged Good First Issues.