Skip to content

Latest commit

 

History

History
81 lines (53 loc) · 2.79 KB

CONTRIBUTING.md

File metadata and controls

81 lines (53 loc) · 2.79 KB

Contributing to Mesh4all

Welcome to contribute to Mesh4all, all ideas are welcome, feel free to share your requirements, comments, bugs or problems. Remember that the main idea is to connect everyone and everything around us.

Check all the following sections according to the requirement you need.


Getting Started


if you are starting to work with mesh4all, you can read our documentation, and you will know all supported boards, and resources.

First Steps:

  1. Cloning
  2. Update submodules.

To start with m4ag-firmware, we need to clone the repository:

1. Cloning

Via SSH:

    git clone git@github.com:Mesh4all/m4a-firmware.git

Via HTTPS:

    git clone https://github.com/Mesh4all/m4a-firmware.git

Note: We recommend cloning through SSH, due to external dependencies of some module


2. Updating Submodules

Our firmware is based on RIOT-OS, so you have to apply updates from the RIOT repository within the m4ag firmware using the following command lines with git.

Enter to the m4ag-firmware directory

    cd m4a-firmware/

update your submodules

    git submodule update --init --recursive

Bug Reports and Feature Request


This link allows you to generate a bug report or a feature request, you will take the option you want.

if you have started to work with the firmware, and some kind of bugs or issues has occurred during the process, please do not hesitate to report it describing it. (We recommend following the structure given by github).

Similarly, if you want to generate a feature request that could complement and help improve the firmware.

Please, before generating a bug report or a feature request, verify that it's not present in the list of issues


Contributing Code


if you think that your work will be a growth for the project, integrate in the repository m4ag-firmware, we recommend:

  1. Fork the m4ag-firmware git repository.
  2. Create your contribution branch.
  3. Give a git push to your branch.
  4. Generate a Pull Request (if you can't see your branch, try repeat the third step).

Thank you very much for your future contribution, we are now connected together in this great mesh around the world!!!.