firmware icon indicating copy to clipboard operation
firmware copied to clipboard
verified publisher icon meshtastic

[Feature Request]: Create a CONTRIBUTING.md file for easier onboarding

Open Tzal3x opened this issue 1 year ago • 3 comments

Platform

other

Description

It would be nice to have a file like CONTRIBUTING.md that describes how to contribute to the project for faster and easier onboarding of new users.

Example sections:

  • How to build the project.
  • What are the usual steps of adding a new board.
  • Any conventions used in the project that should be followed by everyone (add linters).

Tzal3x avatar Aug 19 '24 08:08 Tzal3x

Related: https://meshtastic.org/docs/development/firmware/build/

https://github.com/meshtastic/meshtastic/pull/1363

fifieldt avatar Aug 19 '24 08:08 fifieldt

Platform

other

Description

It would be nice to have a file like CONTRIBUTING.md that describes how to contribute to the project for faster and easier onboarding of new users.

Example sections:

  • How to build the project.
  • What are the usual steps of adding a new board.
  • Any conventions used in the project that should be followed by everyone (add linters).

We have this info on the website: https://meshtastic.org/docs/development/firmware/

rcarteraz avatar Aug 19 '24 13:08 rcarteraz

I'm actually a +1 on adding the file to the source, even if it's not much more than a link to the web docs.

jp-bennett avatar Aug 19 '24 16:08 jp-bennett