Skip to content

Latest commit

 

History

History
17 lines (9 loc) · 1.53 KB

CONTRIBUTING.md

File metadata and controls

17 lines (9 loc) · 1.53 KB

Contribution Guidlines

The best way to ask for help or propose a new idea is to create a new issue while creating a Pull Request with your code changes allows you to share your own innovations with the rest of the community.

The following are some guidelines to observe when creating issues or PRs:

  • Be friendly; it is important that we can all enjoy a safe space as we are all working on the same project and it is okay for people to have different ideas

  • Use code blocks; it helps us help you when we can read your code! On that note also refrain from pasting more than 30 lines of code in a post, instead create a gist if you need to share large snippets

  • Titles follows Conventional Commits (eg. feat: My Awesome Feature, fix(topic): Something bad)

  • Be detailed; refrain from mentioning code problems without sharing your source code and always give information regarding your board and version of the library

  • Ensure your code are properly formed with clang-format and passes quality gates with pio checks

  • Using Visual Studio Code with the PlatformIO extension is highly recommended. The environment will be automatically configured, select an example environment and PIO will build the project for you.