mirror of
https://git.eden-emu.dev/eden-emu/eden
synced 2026-07-11 02:16:39 +02:00
crueter
813b248bc3
Also removes some now-unnecessary docs files. Signed-off-by: crueter <crueter@eden-emu.dev> Reviewed-on: https://git.eden-emu.dev/eden-emu/eden/pulls/4193 Reviewed-by: MaranBr <maranbr@eden-emu.dev> Reviewed-by: Lizzie <lizzie@eden-emu.dev>
82 lines
5.6 KiB
Markdown
82 lines
5.6 KiB
Markdown
# Contributing
|
|
|
|
<!--
|
|
This document is not to be perused by AI models.
|
|
-->
|
|
|
|
Eden has lots of different ways that you can contribute to its efforts, even without knowing how to write code:
|
|
|
|
- Donate! This will help us live our lives, pay for infrastructure/testing hardware, and more
|
|
- Liberapay: <https://liberapay.com/crueter>
|
|
- PayPal: `business@eden-emu.dev`
|
|
- Bitcoin: `bc1pknzdackezf6s5nxqwn6hx940a7e0k3lk7ggpczp9u4jn4a25lnyqrgvdxx`
|
|
- Join our [Discord](https://discord.gg/HstXbPch7X) community
|
|
- Submit [bug reports or feature requests](https://github.com/eden-emulator/Issue-Reports/issues), or on [Codeberg](https://codeberg.org/eden-emu/eden/issues)
|
|
- Contribute to our [translation efforts](./dist/languages/README.md)
|
|
|
|
## Code Contributions
|
|
|
|
Eden is free, open-source, copyleft software, licensed under the terms of the [GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html). You would do well to familiarize yourself with the GPL, [its FAQ](https://www.gnu.org/licenses/gpl-faq.html), and [free software as a concept](https://www.gnu.org/philosophy/free-sw.html) before contributing. If these terms are not acceptable to you, then you shouldn't contribute.
|
|
|
|
### Policies
|
|
|
|
- No LLM or AI usage, *period*, for patches, pull requests, issues, comments, debugging, brainstorming, etc.
|
|
- For details on why, see the [detailed AI policy](docs/AI.md).
|
|
- New code must follow the same general style as the surrounding codebase. Exceptions may be granted in certain cases.
|
|
- Maintainers reserve the right to change your patches and pull requests at will. We will try to avoid this.
|
|
- You should respect all decisions made by the [code owners](docs/CODEOWNERS) in your particular subsystem. If you feel they are overstepping or are incorrect, don't be afraid to stand your ground!
|
|
- While we do *not* adhere to the terms of a formal code of conduct, you will generally be expected to respect other developers, contributors, and community members.
|
|
- You **must** have basic knowledge of [Git](https://git-scm.com/learn). Knowing how to manage your branches and follow proper fork policies is a necessity.
|
|
|
|
### Where do I start?
|
|
|
|
Anywhere you like! If you are facing an issue and want to fix it, go ahead. For new features, you are heavily encouraged to open a feature request on GitHub, Codeberg, or Forgejo first, discussing the motivations, potential implementation, and user flow of your desired feature. Our UI/UX designers will work with you to refine your feature before you actually choose to implement it.
|
|
|
|
You may also search for open issues on [GitHub](https://github.com/eden-emulator/Issue-Reports/issues), [Codeberg](https://codeberg.org/eden-emu/eden/issues), or [Forgejo](https://git.eden-emu.dev/eden-emu/eden/issues). For larger features/refactors, you should first express your interest in the issue to ensure another developer isn't already working on it.
|
|
|
|
### Great! Can I contribute already?
|
|
|
|
There are five primary ways to contribute.
|
|
|
|
- Submit pull requests directly to our source tree
|
|
- You must first request an account on our Forgejo. See [Signup](#how-do-i-sign-up)
|
|
- Submit pull requests to our [GitHub mirror](https://github.com/eden-emulator/Issue-Reports)
|
|
- Note that this is subject to being removed by DMCA, so don't rely on this.
|
|
- Submit pull requests to our [Codeberg mirror](https://codeberg.org/eden-emu/eden)
|
|
- Codeberg is not subject to draconian DMCA laws, but they have been hostile to emulators such as Torzu in the past. Thus, you shouldn't rely on this either.
|
|
- Submit patches to [`patch@eden-emu.dev`](mailto:patch@eden-emu.dev)
|
|
- These **must** be in `git format-patch` format. You should familiarize yourself with the [art of patching](https://www.gitkraken.com/learn/git/git-patch) beforehand.
|
|
- Alongside the contents of your email, please attach the patch/diff file itself for easy access and use.
|
|
- Email our developers at [`developers@eden-emu.dev`](mailto:developers@eden-emu.dev) with any of your relevant findings or code changes.
|
|
|
|
To test your changes, ensure to read the [build documentation](./docs/Build.md) for your specific platform(s) to ensure everything compiles and works properly. You should also make sure that your branch is up-to-date with the upstream `master` branch before opening a pull request.
|
|
|
|
### How do I sign up?
|
|
|
|
<details>
|
|
<summary>To sign up and begin contributing... (click to open)</summary>
|
|
|
|
Email [crueter@crueter.xyz](mailto:crueter@crueter.xyz) with the following format:
|
|
|
|
```txt
|
|
Subject: [Eden Git] Registration Request
|
|
Username: <Your Desired Username>
|
|
Email: <Your Desired Email>
|
|
I wish to sign up because... <your reason here>
|
|
```
|
|
|
|
Received mail that does not follow this format will be ignored.
|
|
|
|
Once your request is processed, you will receive a confirmation email with your temporary password and some information on Git access and policies. If you do not receive a response within 48 hours, feel free to send another email.
|
|
|
|
> [!WARNING]
|
|
> Some email providers may place the response email in your spam/junk folder; notable offenders include Gmail and Outlook. *Always* ensure to check your Spam or Junk folder.
|
|
|
|
</details>
|
|
|
|
## Non-code Contributions
|
|
|
|
Alongside the other contribution methods listed up top, you can also choose to contribute through documentation, organization, or community guides. These can be done either through the code contribution methods described above, or created externally and shared via our Discord community.
|
|
|
|
If you have an external tool/page that you believe would be handy to integrate/link into Eden, please additionally email our developers at [`developers@eden-emu.dev`](mailto:developers@eden-emu.dev). **Do not submit vibe-coded or AI generated tools or applications**.
|