/hello.dev

hello.dev content

Primary LanguageJavaScript

hello.dev

This repo contains the source code and documentation powering https://hello.dev/.

Getting started

Prerequisites

  1. Git
  2. Node: any 12.x version starting with v12.0.0 or greater
  3. npm
  4. A fork of the repo (for any contributions)
  5. A clone of the hello.dev repo on your local machine

Installation

  1. cd hello.dev to go into the project root
  2. npm i to install the npm dependencies

Running locally

  1. npm run dev to start the hot-reloading development server (powered by Vite)
  2. open http://localhost:8080 to open the site in your favorite browser

Contributing

Discussions

Head over to our (GitHub Discussions)[https://github.com/hellocoop/hello.dev/discussions] page to ask and answer questions, get updates, have open-ended conversations, and follow along on decisions affecting the community's way of working.

Guidelines

The documentation is divided into several sections with a different tone and purpose. If you plan to write more than a few sentences, you might find it helpful to get familiar with the contributing guidelines for the appropriate sections. Also make sure to go through our Code Of Conduct.

Create a branch

  1. git checkout main from any folder in your local hello.dev repository
  2. git pull origin main to ensure you have the latest main code
  3. git checkout -b the-name-of-my-branch (replacing the-name-of-my-branch with a suitable name) to create a branch

Make the change

  1. Follow the "Running locally" instructions
  2. Save the files and check in the browser
  3. Changes to markdown files in src will hot-reload

Test the change

If possible, test any visual changes in all latest versions of common browsers, on both desktop and mobile.

Push it

  1. git add -A && git commit -m "My message" (replacing My message with a commit message, such as Fix navbar height on mobile) to stage and commit your changes
  2. git push my-fork-name the-name-of-my-branch
  3. Go to the hello.dev repo and you should see recently pushed branches.
  4. Follow GitHub's instructions.
  5. If possible, include screenshots of visual changes. A preview build is triggered after your changes are pushed to GitHub.

License

Content submitted to hello.dev is xxx, as found in the LICENSE-DOCS.md file.