meshtastic/protobufs
1
0
Fork 0
mirror of https://github.com/meshtastic/protobufs.git synced 2026-04-20 22:13:55 +00:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #228 from meshtastic/update-readme

Browse source 
Update readme
This commit is contained in:
Thomas Göttgens 2022-10-31 10:24:55 +01:00 • committed by GitHub
commit ed9f2499d6
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 11 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

6
.github/pull_request_template.md vendored
View file

@ -1,9 +1,13 @@
<!-- Describe what you are intending to change -->
## What does this PR do?
<!-- Please remove or replace the issue url -->
> [Related Issue](https://github.com/meshtastic/Meshtastic-protobufs/issues/0)
> [Related Issue](https://github.com/meshtastic/protobufs/issues/0)
## Checklist before merging
- [ ] All top level messages commented
- [ ] All enum members have unique descriptions
- [ ] Formatting is consistant with the defined protolint rules

9
README.md
View file

@ -1,7 +1,7 @@
# Meshtastic-protobufs
# Meshtastic Protobuf Definitions
[![CI](https://img.shields.io/github/workflow/status/meshtastic/Meshtastic-protobufs/CI?label=actions&logo=github&color=yellow)](https://github.com/meshtastic/Meshtastic-protobufs/actions/workflows/ci.yml)
[![CLA assistant](https://cla-assistant.io/readme/badge/meshtastic/Meshtastic-protobufs)](https://cla-assistant.io/meshtastic/Meshtastic-protobufs)
[![CI](https://img.shields.io/github/workflow/status/meshtastic/protobufs/CI?label=actions&logo=github&color=yellow)](https://github.com/meshtastic/protobufs/actions/workflows/ci.yml)
[![CLA assistant](https://cla-assistant.io/readme/badge/meshtastic/protobufs)](https://cla-assistant.io/meshtastic/protobufs)
[![Fiscal Contributors](https://opencollective.com/meshtastic/tiers/badge.svg?label=Fiscal%20Contributors&color=deeppink)](https://opencollective.com/meshtastic/)
[![Vercel](https://img.shields.io/static/v1?label=Powered%20by&message=Vercel&style=flat&logo=vercel&color=000000)](https://vercel.com?utm_source=meshtastic&utm_campaign=oss)
@ -13,8 +13,9 @@ The [Protobuf](https://developers.google.com/protocol-buffers) message definitio
## Stats
![Alt](https://repobeats.axiom.co/api/embed/22ac2d1a4668b8a5fc7832e8800c0e528a45d78a.svg "Repobeats analytics image")
![Alt](https://repobeats.axiom.co/api/embed/47e9ee1d81d9c0fdd2b4b5b4c673adb1756f6db5.svg "Repobeats analytics image")
## Linter Setup
Linting is performed by [protolint](https://github.com/yoheimuta/protolint)
Once installed, the Visual Studio Code extension [Proto Lint](https://marketplace.visualstudio.com/items?itemName=Plex.vscode-protolint) will perform linting automatically on save.

2
portnums.proto
View file

@ -131,7 +131,7 @@ enum PortNum {
/*
* Private applications should use portnums >= 256.
* To simplify initial development and testing you can use "PRIVATE_APP"
* in your code without needing to rebuild protobuf files (via [regen-protos.sh](https://github.com/meshtastic/Meshtastic-device/blob/master/bin/regen-protos.sh))
* in your code without needing to rebuild protobuf files (via [regen-protos.sh](https://github.com/meshtastic/firmware/blob/master/bin/regen-protos.sh))
*/
PRIVATE_APP = 256;