Skip to content
Open
Show file tree
Hide file tree
Changes from 10 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
<!--- Provide a general summary of your changes in the Title above -->

## PR checklist

- [ ] This comment contains a description of changes (with reason).
- [ ] The ROM compiles to matching locally (`make compare_heartgold && make compare_soulsilver`).
- [ ] All C code is correctly formatted (`git clang-format`).
- [ ] This pull request is labeled according to the kind of work it represents.
<!-- Uncomment this after decompilation is finished
- [ ] New or updated code labels follow the [style guide]()
Comment thread
adrienntindall marked this conversation as resolved.
-->
- [ ] This work adheres to the [AI policy](CONTRIBUTING.md#ai-policy).

## **Discord contact info**
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that discord verification is important but I'm hesitant to require it as part of a PR for everyone since it'll be public information, and discord stalkers are real (speaking from experience). It might just be worth having them join and verify by sending a message in #pokeheartgold

We can add the following the the above checklist instead

[ ] The author has joined the pret discord community and sent a message in #pokeheartgold to verify that they are human

Reasonably though any human contributor would do this anyways, so it might be redundant.

<!--- Formatted as username (e.g. pikalaxalt) or username#numbers (e.g. PikalaxALT#5823) -->
<!--- Contributors must join https://discord.gg/d5dubZ3 -->
11 changes: 11 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,22 @@
# Contributing to pret/pokeheartgold

<!--toc:start-->
- [AI Policy](#ai-policy)
- [Code Formatting](#code-formatting)
<!--toc:end-->

This document provides a synopsis and loose guidelines for how to contribute to this project. It is a work in progress. Maintainers should expand this document.

ALL PERSONS OPENING PULL REQUESTS TO THIS REPOSITORY AGREE TO ABIDE BY THE POLICIES OUTLINED IN THIS DOCUMENT.

## AI Policy

We unequivocally prohibit the use of artifical intelligence (AI) large language models (LLMs) to generate contributions to this project, meaningful or otherwise. Any pull request found to have used AI for these tasks will be closed, and the contributor will be banned from interacting with the repository. This is a zero-tolerance policy, and we do not provide any avenue for appeal.

The following use cases are deemed acceptable and stand as exceptions to the above statement, provided that they are disclosed in full. While this document is not legally binding, we do expect you to represent yourself truthfully. Undisclosed use of AI may result in a ban.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

question: Do we want to explicitly outline an exception for translating text from issues / comments / pull requests? Does that count as a contribution?

Would it be better to outline what a "contribution" is? In my mind, a contribution to these repositories is any of the following:

  • Decompilation of assembly instructions to C
  • Documentation of C code for readability or semantic-meaning
  • Text-documentation (e.g., writing a "how the game works" Markdown document)
  • Creating issues
  • Unpacking archives into editable assets
  • Creating tools for translating in-repo assets to in-game assets

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

contribution is pretty defined imo
anything that adds to the repo is a contribution
imo there are many better tools for translation than llms but I dont know how we'd ban that?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

but if it's translation that is committing to the repo and uses llm, it shouldn't be added to the repo

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

anything that adds to the repo is a contribution

Is creating an issue to report some inconsistency or misdocumentation a contribution to the repository? It contributed to the GitHub plumbing, but not inherently to the git tree, which I think is fuzzily-defined as written.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd say so
creating AI slop issues is not gonna be very productive and get a good response

Copy link
Copy Markdown
Contributor

@lhearachel lhearachel Apr 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right. I agree. My argument is that "contribution" is a bit ambiguous by itself, and it's low-cost to outline examples (including some language like "not limited to") of what we deem to be contributions.

- Automating the boring stuff. So long as the task is clearly defined by a human, is boiled down to pure execution with no further creative decision-making, and is sufficiently tedious to perform by hand. you may delegate it to an AI. However, we do strongly encourage you to do as much as you can by hand or write a script to automate the task, rather than invoking an AI to do it for you.
Comment thread
adrienntindall marked this conversation as resolved.
Outdated
- Asking general knowledge questions about C code, the ARM processor, Pokémon, etc.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion: Provide a means by which a potential contributor can ask questions that doesn't involve an LLM. This could be as simple as nudging them to either join the pret Discord server or open an issue.


## Code Formatting

This repository includes an opinionated `clang-format` specification to ensure that we maintain a common code style. For convenience, a pre-commit hook is also provided in `.githooks` which will run `clang-format` against any staged changes prior to executing a commit.
Expand Down
Loading