Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

HIP-1037 - Protocol Buffer Specification #1037

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

HIP-1037 - Protocol Buffer Specification #1037

wants to merge 3 commits into from
+528 −0

Commits on Nov 7, 2024

  1. Create HIP for Protocol Buffer Specification 

     * Initial proposed HIP text

Signed-off-by: Joseph Sinclair <[email protected]>

Update hip-1037.md to Review

Signed-off-by: Michael Garber <[email protected]>
    @jsync-swirlds
    jsync-swirlds committed Nov 7, 2024
    Configuration menu
    Copy the full SHA
    9448414 View commit details
    Browse the repository at this point in the history

  2. Review Updates 

    - Added style guidelines as an asset.
   - Linked these guidelines in the specification section
- Moved the large PR link to the reference implementation section
- Added reference to protoc-gen-doc
- Added two rejected ideas
- Added paragraph breaks in two places
- Updated style guidelines to mention PBJ and Map field concerns.
- Adjusted style guidelines to add section headings and
  clarify the examples.

Signed-off-by: Joseph Sinclair <[email protected]>
    @jsync-swirlds
    jsync-swirlds committed Nov 7, 2024
    Configuration menu
    Copy the full SHA
    72456d3 View commit details
    Browse the repository at this point in the history

  3. More review updates 

     - Added some additional sample content
 - Clarified "equivalent" types with respect to these guidelines
 - Clarified line break usage
 - Clarified when a horizontal rule (`<hr>`) tag is appropriate
 - Added additional clarification for paragraph breaks
 - Added guideline for non-API comments using "line oriented" (`//`)
   style comments.
 - Added a user story related to smart contract requirements.

Signed-off-by: Joseph Sinclair <[email protected]>
    @jsync-swirlds
    jsync-swirlds committed Nov 7, 2024
    Configuration menu
    Copy the full SHA
    eea1903 View commit details
    Browse the repository at this point in the history