From f91e6f1764bb8dea3c9e9c77ee39642d85db22b3 Mon Sep 17 00:00:00 2001 From: Leah Amelia Chen Date: Fri, 29 Aug 2025 05:48:15 +0800 Subject: [PATCH] docs: better integrate CONTRIBUTING into the README --- CONTRIBUTING.md | 1 - README.md | 14 ++++++++++---- 2 files changed, 10 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1f6d8193d..777771145 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -137,4 +137,3 @@ pull request will be accepted with a high degree of certainty. > **Pull requests are NOT a place to discuss feature design.** Please do > not open a WIP pull request to discuss a feature. Instead, use a discussion > and link to your branch. - diff --git a/README.md b/README.md index d932b4586..df86f7830 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,8 @@ · Documentation · + Contributing + · Developing

@@ -49,6 +51,14 @@ See the [download page](https://ghostty.org/download) on the Ghostty website. See the [documentation](https://ghostty.org/docs) on the Ghostty website. +## Contributing and Developing + +If you have any ideas, issues, etc. regarding Ghostty, or would like to +contribute to Ghostty through pull requests, please check out our +["Contributing to Ghostty"](CONTRIBUTING.md) document. Those who would like +to get involved with Ghostty's development as well should also read the +["Developing Ghostty"](HACKING.md) document for more technical details. + ## Roadmap and Status The high-level ambitious plan for the project, in order: @@ -184,7 +194,3 @@ SENTRY_DSN=https://e914ee84fd895c4fe324afa3e53dac76@o4507352570920960.ingest.us. > stack memory of each thread at the time of the crash. This information > is used to rebuild the stack trace but can also contain sensitive data > depending when the crash occurred. - -## Developing Ghostty - -Please check out our [HACKING.md](HACKING.md) for more details.