Skip to content

Latest commit

 

History

History
81 lines (52 loc) · 3.11 KB

CONTRIBUTING.md

File metadata and controls

81 lines (52 loc) · 3.11 KB

Contributing to bytebeam-esp-idf-sdk

If you have loved using bytebeam-esp-idf-sdk and want to give back, we would love to have you open GitHub issues and PRs for features, bugs and documentation improvements.

Before you start, please make yourself familiar with the architecture of bytebeam-esp-idf-sdk and read the design docs before making your first contribution to increase it's chances of being adopted. Please follow the Code of Conduct when communicating with other members of the community and keep discussions civil, we are excited to have you make your first of many contributiions to this repository, welcome!

Steps to Contribute

Getting the project

Go to https://github.com/bytebeamio/bytebeam-esp-idf-sdk and fork the project repository.

# Open the terminal where you want to do the project setup
$ cd path_to_project_setup

# Remove the bytebeam-esp-idf-sdk project if any
$ rmdir /s /q bytebeam-esp-idf-sdk

# Clone your fork
$ git clone [email protected]:<YOU>/bytebeam-esp-idf-sdk.git

# Step into project directory
$ cd bytebeam-esp-idf-sdk

# Create a branch for your changes (say my_topical_branch)
$ git checkout -b my_topical_branch

Project Setup

Before stepping into project setup, launch the esp-idf framework. If you have not installed the esp-idf framework yet then the best place to get started will be the Espressif Getting Started Guide

# Make sure idf.py tool is accessible
$ idf.py --version

# Make sure the target is available in the current version of esp-idf
$ idf.py --list-targets

# Step into project directory if not there
$ cd path_to_project_dir

# Step into any example project (say toggle_led)
$ cd examples/toggle_led

# Set the target (say esp32)
$ idf.py set-target esp32

# Configure your project
$ idf.py menuconfig

# Build, Flash and Monitor
$ idf.py -p PORT flash monitor

For more information on build system check out Espressif Build System Guide

Making Changes

Please make sure your changes conform to Espressif IoT Development Framework Style Guide

Testing & CI

Tests Suite is not yet added to the repo, will add it once we are done with the development cycle of the first release. By the way you can contribute this too :)

Add yourself to Contributors

Thank you for contributing to bytebeam-esp-idf-sdk, Please feel free to add yourself to Contributors

License

bytebeam-esp-idf-sdk is licensed under the permissive Apache License Version 2.0 and we accept contributions under the implied notion that they are made in complete renunciation of the contributors any rights or claims to the same after the code has been merged into the codebase.