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

Update README.md #11

Open
alecchendev opened this issue Mar 8, 2022 · 0 comments
Open

Update README.md #11

alecchendev opened this issue Mar 8, 2022 · 0 comments
Assignees
Labels
atomic Single task, well defined documentation Improvements or additions to documentation

Comments

@alecchendev
Copy link
Member

alecchendev commented Mar 8, 2022

Now that gitbook docs are launched, we can change readme to more of a basic overview and contribution guidelines

  • still keep basic description
  • links to website, twitter, docs
  • how to build and deploy program
  • overview of scripts and how to run
  • running our website - look in head tag for a helpful comment, also its literally an html file lmao
  • contributing - basically our engineering flow: assign yourself an issue, create new branch, dummy commit, draft PR, make changes, change PR to be ready for review, request review, iterate, merge
  • Also add a part on why we went with raw solana and not anchor - mainly we wanted to build and hadn't learned anchor yet but we had alr gotten started with raw SOL for fundamentals/intuition
@alecchendev alecchendev changed the title Add Contribution Guidelines to README.md Update README.md Mar 13, 2022
@alecchendev alecchendev added documentation Improvements or additions to documentation atomic Single task, well defined labels Mar 13, 2022
@alecchendev alecchendev self-assigned this Mar 24, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
atomic Single task, well defined documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant