👍🎉First off, thanks for taking the time to contribute🎉👍
The following is a set of guidelines on how to contribute
The docs are layed out in 4 different sections.
| Section | Description |
|---|---|
| Api Reference | References to the various App interfaces for hyper |
| Concepts | Building blocks of hyper that are good to know for development |
| Build | References and guides on how to build with hyper |
| Host | Guides on how to host hyper |
Depending on what you are writing, it will live in one of these sections.
If you use GitPod, this is all done for you.
yarn
yarn devIt will take some time to start, the documentation can then be viewed at (http://localhost:5473/)
To start work, do the following:
- Create an issue and/or comment on an existing issue to state you've started working
- Create a PR during or when complete
Missing something on the docs? Think there should be another section? Please create an issue and we'll try to get it added!
We are using conventional commits for this repository.
General flow for making a contribution:
- Fork the repo on GitHub
- Clone the project to your own machine
- Commit changes to your own branch
- Push your work back up to your fork
- Submit a Pull request so that we can review your changes
NOTE: Be sure to merge the latest from "upstream" before making a pull request!