Skip to content

Adds new README, BUILD, and CONTRIBUTING files.#232

Open
johnnymatthews wants to merge 2 commits into
mainfrom
update/readme-and-repo-docs
Open

Adds new README, BUILD, and CONTRIBUTING files.#232
johnnymatthews wants to merge 2 commits into
mainfrom
update/readme-and-repo-docs

Conversation

@johnnymatthews
Copy link
Copy Markdown
Contributor

Uses basic templates for README, CONTRIBUTING, and BUILD files. Should clear up confusion as to what this repo is for, how to use it, and all that jazz.

Changes

Three new files:

  • README.md
  • BUILD.md
  • CONTRIBUTING.md

Related Issue

Addresses https://github.com/shinzonetwork/meta/issues/7

Steps to Test

  • Run through the steps in README.md and BUILD.md to see if they actually work.

Checklist

  • Code compiles / runs
  • Tests added / updated
  • Documentation updated if needed
  • PR is self-contained and focused
  • Code does not break any existing features
  • Code passes personal internal testing

Notes

N/a

Uses basic templates for all three files. Should clear up confusion as
to what this repo is for, how to use it, and all that jazz.
@johnnymatthews johnnymatthews marked this pull request as ready for review May 28, 2026 08:10
Copy link
Copy Markdown
Collaborator

@VanishMax VanishMax left a comment

Choose a reason for hiding this comment

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

Great! 👍

Only one non-blocking question.

Comment thread README.md
Comment on lines +42 to +44
## Contributing

Open an issue before submitting a PR. See [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

question: do we need a license section?

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.

2 participants