aboutsummaryrefslogtreecommitdiff
path: root/vendor/libghostty-vt/CONTRIBUTING.md
diff options
context:
space:
mode:
authorCan Celik <ogulcancelik@gmail.com>2026-04-04 19:22:04 +0300
committerCan Celik <ogulcancelik@gmail.com>2026-04-05 01:23:06 +0300
commit41dd733ca7123c9ac4bfc6c781697a660e95b052 (patch)
tree3fc91815ca139ef2e0b281bba0abda4ef15175f4 /vendor/libghostty-vt/CONTRIBUTING.md
parent55c138263e190a1e79d4b997bfb9397306c0ec1f (diff)
feat: finish ghostty pane backend integration
Diffstat (limited to 'vendor/libghostty-vt/CONTRIBUTING.md')
-rw-r--r--vendor/libghostty-vt/CONTRIBUTING.md200
1 files changed, 200 insertions, 0 deletions
diff --git a/vendor/libghostty-vt/CONTRIBUTING.md b/vendor/libghostty-vt/CONTRIBUTING.md
new file mode 100644
index 00000000..b6be800c
--- /dev/null
+++ b/vendor/libghostty-vt/CONTRIBUTING.md
@@ -0,0 +1,200 @@
+# Contributing to Ghostty
+
+This document describes the process of contributing to Ghostty. It is intended
+for anyone considering opening an **issue**, **discussion** or **pull request**.
+For people who are interested in developing Ghostty and technical details behind
+it, please check out our ["Developing Ghostty"](HACKING.md) document as well.
+
+> [!NOTE]
+>
+> I'm sorry for the wall of text. I'm not trying to be difficult and I do
+> appreciate your contributions. Ghostty is a personal project for me that
+> I maintain in my free time. If you're expecting me to dedicate my personal
+> time to fixing bugs, maintaining features, and reviewing code, I do kindly
+> ask you spend a few minutes reading this document. Thank you. ❤️
+
+## The Critical Rule
+
+**The most important rule: you must understand your code.** If you can't
+explain what your changes do and how they interact with the greater system
+without the aid of AI tools, do not contribute to this project.
+
+Using AI to write code is fine. You can gain understanding by interrogating an
+agent with access to the codebase until you grasp all edge cases and effects
+of your changes. What's not fine is submitting agent-generated slop without
+that understanding. Be sure to read the [AI Usage Policy](AI_POLICY.md).
+
+## AI Usage
+
+The Ghostty project has strict rules for AI usage. Please see
+the [AI Usage Policy](AI_POLICY.md). **This is very important.**
+
+## First-Time Contributors
+
+We use a vouch system for first-time contributors:
+
+1. Open a
+ [discussion in the "Vouch Request"](https://github.com/ghostty-org/ghostty/discussions/new?category=vouch-request)
+ category describing what you want to change and why. Follow the template.
+2. Keep it concise
+3. Write in your own voice, don't have an AI write this
+4. A maintainer will comment `!vouch` if approved
+5. Once approved, you can submit PRs
+
+If you aren't vouched, any pull requests you open will be
+automatically closed. This system exists because open source works
+on a system of trust, and AI has unfortunately made it so we can no
+longer trust-by-default because it makes it too trivial to generate
+plausible-looking but actually low-quality contributions.
+
+## Contributors Prior to the Vouch System
+
+If you contributed to Ghostty prior to the introduction
+of the vouch system and wish to continue contributing, you were not
+automatically added to the [list of vouched users](.github/VOUCHED.td). You will need to follow the same
+process as a first-time contributor to be vouched.
+
+## Denouncement System
+
+If you repeatedly break the rules of this document or repeatedly
+submit low quality work, you will be **denounced.** This adds your
+username to a public list of bad actors who have wasted our time. All
+future interactions on this project will be automatically closed by
+bots.
+
+The denouncement list is public, so other projects who trust our
+maintainer judgement can also block you automatically.
+
+## Quick Guide
+
+### I'd like to contribute
+
+[All issues are actionable](#issues-are-actionable). Pick one and start
+working on it. Thank you. If you need help or guidance, comment on the issue.
+Issues that are extra friendly to new contributors are tagged with
+["contributor friendly"].
+
+["contributor friendly"]: https://github.com/ghostty-org/ghostty/issues?q=is%3Aissue%20is%3Aopen%20label%3A%22contributor%20friendly%22
+
+### I'd like to translate Ghostty to my language
+
+We have written a [Translator's Guide](po/README_TRANSLATORS.md) for
+everyone interested in contributing translations to Ghostty.
+Translations usually do not need to go through the process of issue triage
+and you can submit pull requests directly, although please make sure that
+our [Style Guide](po/README_TRANSLATORS.md#style-guide) is followed before
+submission.
+
+### I have a bug! / Something isn't working
+
+First, search the issue tracker and discussions for similar issues. Tip: also
+search for [closed issues] and [discussions] — your issue might have already
+been fixed!
+
+> [!NOTE]
+>
+> If there is an _open_ issue or discussion that matches your problem,
+> **please do not comment on it unless you have valuable insight to add**.
+>
+> GitHub has a very _noisy_ set of default notification settings which
+> sends an email to _every participant_ in an issue/discussion every time
+> someone adds a comment. Instead, use the handy upvote button for discussions,
+> and/or emoji reactions on both discussions and issues, which are a visible
+> yet non-disruptive way to show your support.
+
+If your issue hasn't been reported already, open an ["Issue Triage"] discussion
+and make sure to fill in the template **completely**. They are vital for
+maintainers to figure out important details about your setup.
+
+> [!WARNING]
+>
+> A _very_ common mistake is to file a bug report either as a Q&A or a Feature
+> Request. **Please don't do this.** Otherwise, maintainers would have to ask
+> for your system information again manually, and sometimes they will even ask
+> you to create a new discussion because of how few detailed information is
+> required for other discussion types compared to Issue Triage.
+>
+> Because of this, please make sure that you _only_ use the "Issue Triage"
+> category for reporting bugs — thank you!
+
+[closed issues]: https://github.com/ghostty-org/ghostty/issues?q=is%3Aissue%20state%3Aclosed
+[discussions]: https://github.com/ghostty-org/ghostty/discussions?discussions_q=is%3Aclosed
+["Issue Triage"]: https://github.com/ghostty-org/ghostty/discussions/new?category=issue-triage
+
+### I have an idea for a feature
+
+Like bug reports, first search through both issues and discussions and try to
+find if your feature has already been requested. Otherwise, open a discussion
+in the ["Feature Requests, Ideas"] category.
+
+["Feature Requests, Ideas"]: https://github.com/ghostty-org/ghostty/discussions/new?category=feature-requests-ideas
+
+### I've implemented a feature
+
+1. If there is an issue for the feature, open a pull request straight away.
+2. If there is no issue, open a discussion and link to your branch.
+3. If you want to live dangerously, open a pull request and
+ [hope for the best](#pull-requests-implement-an-issue).
+
+### I have a question which is neither a bug report nor a feature request
+
+Open an [Q&A discussion], or join our [Discord Server] and ask away in the
+`#help` forum channel.
+
+Do not use the `#terminals` or `#development` channels to ask for help —
+those are for general discussion about terminals and Ghostty development
+respectively. If you do ask a question there, you will be redirected to
+`#help` instead.
+
+> [!NOTE]
+> If your question is about a missing feature, please open a discussion under
+> the ["Feature Requests, Ideas"] category. If Ghostty is behaving
+> unexpectedly, use the ["Issue Triage"] category.
+>
+> The "Q&A" category is strictly for other kinds of discussions and do not
+> require detailed information unlike the two other categories, meaning that
+> maintainers would have to spend the extra effort to ask for basic information
+> if you submit a bug report under this category.
+>
+> Therefore, please **pay attention to the category** before opening
+> discussions to save us all some time and energy. Thank you!
+
+[Q&A discussion]: https://github.com/ghostty-org/ghostty/discussions/new?category=q-a
+[Discord Server]: https://discord.gg/ghostty
+
+## General Patterns
+
+### Issues are Actionable
+
+The Ghostty [issue tracker](https://github.com/ghostty-org/ghostty/issues)
+is for _actionable items_.
+
+Unlike some other projects, Ghostty **does not use the issue tracker for
+discussion or feature requests**. Instead, we use GitHub
+[discussions](https://github.com/ghostty-org/ghostty/discussions) for that.
+Once a discussion reaches a point where a well-understood, actionable
+item is identified, it is moved to the issue tracker. **This pattern
+makes it easier for maintainers or contributors to find issues to work on
+since _every issue_ is ready to be worked on.**
+
+If you are experiencing a bug and have clear steps to reproduce it, please
+open an issue. If you are experiencing a bug but you are not sure how to
+reproduce it or aren't sure if it's a bug, please open a discussion.
+If you have an idea for a feature, please open a discussion.
+
+### Pull Requests Implement an Issue
+
+Pull requests should be associated with a previously accepted issue.
+**If you open a pull request for something that wasn't previously discussed,**
+it may be closed or remain stale for an indefinite period of time. I'm not
+saying it will never be accepted, but the odds are stacked against you.
+
+Issues tagged with "feature" represent accepted, well-scoped feature requests.
+If you implement an issue tagged with feature as described in the issue, your
+pull request will be accepted with a high degree of certainty.
+
+> [!NOTE]
+>
+> **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.