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.

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

Proposed github process modification. #1050

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

jsync-swirlds
Copy link
Member

@jsync-swirlds jsync-swirlds commented Sep 20, 2024

This proposed modification adds detail for how to handle specification text that is excessively large, and would only obscure the substance of a HIP if included inline.

  • Clean up the README file, wrap long lines for readbility, and fix some typographic issues.
  • Clean up the hip-0000-template.md file, wrap long lines for readability (and to encourage the same in HIP documents), and fix some typographic issues
  • Added content to the "Specification" section to describe a recommended method for handling excessively large specification text, along with a small example.
  • Added a folder and sample file (copied from HIP-904 implementation) to support the example.

Copy link

netlify bot commented Sep 20, 2024

Deploy Preview for hedera-hips ready!

Name Link
🔨 Latest commit ff1f16f
🔍 Latest deploy log https://app.netlify.com/sites/hedera-hips/deploys/672c24f30e86ac00083d2e05
😎 Deploy Preview https://deploy-preview-1050--hedera-hips.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@jsync-swirlds jsync-swirlds marked this pull request as ready for review October 29, 2024 19:18
@jsync-swirlds jsync-swirlds requested review from a team and mgarbs as code owners October 29, 2024 19:18
@jsync-swirlds jsync-swirlds requested review from dalvizu and jeromy-cannon and removed request for tinker-michaelj October 29, 2024 19:18
Nana-EC
Nana-EC previously approved these changes Nov 6, 2024
Copy link
Contributor

@Nana-EC Nana-EC left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LG. 1 suggestion and 1 Q

assets/hip-0000-template/sample.proto Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
This proposed modification adds detail for how to handle
specification text that is excessively large, and would only
obscure the substance of a HIP if included inline.
* Remove two obsolete copied files (both are still present in
  the `hip` folder, and were identical to those versions).
* Clean up the README file, wrap long lines for readbility,
  and fix some typographic issues.
* Clean up the hip-0000-template.md file, wrap long lines
  for readability (and to encourage the same in HIP documents),
  and fix some typographic issues
* Added content to the "Specification" section to describe a
  recommended method for handling excessively large
  specification text, along with a small example.
* Added a folder and sample file (copied from HIP-904
  implementation) to support the example.

Signed-off-by: Joseph Sinclair <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants