Add some repo information

- Fix #102
- Fix #96
This commit is contained in:
Jesse Talavera-Greenberg 2023-10-31 16:40:02 -04:00
parent 20c328c1f4
commit ea5b7d2fa2
2 changed files with 264 additions and 0 deletions

136
.github/ISSUE_TEMPLATE/bug-report.yml vendored Normal file
View File

@ -0,0 +1,136 @@
name: Bug Report
description: Found a problem? Tell us so we can fix it!
title: "[Bug] <title>"
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to help improve melonDS DS!
Please answer the following questions to the best of your ability.
- type: input
id: version
attributes:
label: What version of melonDS DS are you using?
description: |
Different frontends have their own ways of showing this info.
In RetroArch, check the lower-left corner of the screen
when paused while the core is loaded.
placeholder: 1.0.1
validations:
required: true
- type: dropdown
id: upstream
attributes:
label: Does the problem happen in upstream melonDS?
description: |
This core stays close to upstream melonDS,
so any bugs present there may affect melonDS DS as well.
**If the answer is yes, please [open a ticket or find an existing one](https://github.com/melonDS-emu/melonDS/issues)
in the upstream melonDS repository.**
You may continue to submit this one,
but it may be closed if there's nothing I can do about it in this repo.
options:
- I don't know.
- Yes, in the [latest stable release](https://github.com/melonDS-emu/melonDS/releases).
- Yes, in the [latest `master` build](https://github.com/melonDS-emu/melonDS).
- No, it's a bug specific to melonDS DS.
- Not applicable, the bug involves features not present in upstream melonDS.
default: 0
validations:
required: true
- type: textarea
id: observed
attributes:
label: What happened?
description: |
Describe the problem you're having,
and provide as much information as you can to help us reproduce it.
Please attach logs, screenshots, videos, savestates, or save data
(otherwise you may be asked to go back and take some).
**Include steps to reproduce the problem if possible;**
bugs that are easy to reproduce are much easier to fix!
placeholder: |
Waluigi is in my computer! Here's a log:
```
[ 0.000000] [FATAL] Waluigi is in your computer!
```
validations:
required: true
- type: textarea
id: expected
attributes:
label: What should've happened instead?
description: |
Please describe what you expected to happen.
If possible, a screenshot of the expected behavior
in upstream [melonDS](https://melonds.kuribo64.net)
or another emulator would be helpful.
placeholder: |
Waluigi should not be in my computer!
His constant screaming is making the emulator unusable.
validations:
required: true
- type: checkboxes
id: platform
attributes:
label: Which platforms do you see the problem on?
options:
- label: Windows
- label: macOS
- label: Linux
- label: Android
- label: iOS
- label: Other (specify below)
validations:
required: true
- type: input
id: platform-version
attributes:
label: Which versions of the OS?
description: Name the version (and other configuration info) of the OS you've reproduced the issue on.
placeholder: Windows 11 21H2, macOS 14 (Apple Silicon), Ubuntu 21.04 (x86_64), etc.
validations:
required: true
- type: input
id: frontend
attributes:
label: Which libretro frontend are you using?
description: |
melonDS DS is primarily designed for RetroArch,
but it will work on other libretro frontends as well.
Tell me which frontend(s) you've seen the problem on,
as well as the version and distribution.
placeholder: RetroArch 1.16.0, Steam and Flatpak releases
validations:
required: true
- type: checkboxes
id: terms
attributes:
label: Terms
description: |
You must understand and agree to the following terms in order to submit this bug report.
If your behavior indicates otherwise, your report may be closed.
options:
- label: I agree to follow the [code of conduct](../CODE_OF_CONDUCT.md).
required: true
- label: I understand that melonDS DS is not developed or maintained by the authors of melonDS.
required: true
- label: |
I understand that the author develops this core in his spare time,
and that he is under no obligation to respond to this bug report.
required: true
- type: markdown
attributes:
value: All good? Thank you very much!

128
CODE_OF_CONDUCT.md Normal file
View File

@ -0,0 +1,128 @@
# Contributor Covenant Code of Conduct
## Our Pledge
We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, religion, or sexual identity
and orientation.
We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.
## Our Standards
Examples of behavior that contributes to a positive environment for our
community include:
* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
overall community
Examples of unacceptable behavior include:
* The use of sexualized language or imagery, and sexual attention or
advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
## Enforcement Responsibilities
Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.
Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.
## Scope
This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
jesse@jesse.tg.
All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the
reporter of any incident.
## Enforcement Guidelines
Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:
### 1. Correction
**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.
**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.
### 2. Warning
**Community Impact**: A violation through a single incident or series
of actions.
**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or
permanent ban.
### 3. Temporary Ban
**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.
**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.
### 4. Permanent Ban
**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.
**Consequence**: A permanent ban from any sort of public interaction within
the community.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).
[homepage]: https://www.contributor-covenant.org
For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.