Skip to content

Commit

Permalink
update README, CONTRIBUTING
Browse files Browse the repository at this point in the history
  • Loading branch information
mitchellh committed Dec 19, 2024
1 parent 1e946a1 commit edb184d
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 12 deletions.
35 changes: 35 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Contributing to Ghostty.org

Ghostty.org is the official Ghostty website.

**Note, Ghostty.org has different contributing guidelines than
the Ghostty project.** They are simpler. If you are familiar with
the Ghostty project contributing guidelines, you probably still
want to read the Quick Guide below.

## Quick Guide

**There is a typo or grammatical error in the website.**

Open a pull request with the correction. No need to make an
issue or discussion.

**There is a behavioral bug in the website.**

Open an issue with clear steps to reproduce the bug.

**There is a feature request for the website.**

[Open a discussion](https://github.com/ghostty-org/ghostty/discussions)
in the _Ghostty project_ repository. All feature requests even
for the website flow through the Ghostty discussions as a central
point.

New pages or new content constitutes a feature request.

Once the feature request is accepted, it will be converted to
an issue in this repository.

**Drive-by pull requests for features are discouraged.** If you
open a PR without previous discussion with a maintainer, you do
so at your own risk.
20 changes: 8 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,24 +10,20 @@

## Local Development

### via Node (recommended)
The official development environment is defined by Nix. You do not need
to use Nix to develop the website, but the Nix environment is the
only supported development environment.

To spin up a local server, you can simply run `make`.

```bash
make
```

Open [http://localhost:3000](http://localhost:3000) with your browser to view the website.
Open [http://localhost:3000](http://localhost:3000) with your browser
to view the website.

### via Docker
## Contributing

If you don't have node configured, you can also build the website locally with Docker.

This approach will compile a [production build](https://nextjs.org/docs/pages/building-your-application/deploying#production-builds), which is less ideal for local development.

```bash
make docker
```

Open [http://localhost:3000](http://localhost:3000) with your browser to view the website.
If you would like to contribute to the website, please read the
[contributing guidelines](CONTRIBUTING.md).

0 comments on commit edb184d

Please sign in to comment.