atiran/sovereignx
3
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

First pass at scope doc and updated PR tempalte

Browse source
This commit is contained in:
pkmnsnfrn 2024-11-21 12:59:51 -08:00
parent 3481340da8
commit f41fdbff6d
2 changed files with 57 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
.github/pull_request_template.md vendored
View file

@ -1,5 +1,9 @@
<!--- Provide a general summary of your changes in the Title above -->
<!--- Before submitting, please make sure your pull request meets the scope guidelines. If unsure, please open a thread in #pr-discussions.-->
<!--- Scope Guidelines: https://github.com/rh-hideout/pokeemerald-expansion/blob/master/docs/scope.md -->
<!--- #pr-discussions: https://discord.com/channels/419213663107416084/1102784418369785948 -->
## Description
<!--- Describe your changes in detail -->

53
docs/scope.md Normal file
View file

@ -0,0 +1,53 @@
# Document Purpose
This document is a guide for contributors and Senate to decide if a feature is within "scope" for pokeemerald-expansion. If a feature is not in scope, then it should not be merged. Even if a opened PR is within scope, this does not mean it will be merged, as acceptance critieria will often come down to the details of the implementation.
# Definitions
* **Showdown Supported (SS)**: A core series game game which metagame can be played on Showdown.
* Notably, this is every [core series game](https://bulbapedia.bulbagarden.net/wiki/Core_series#List_of_core_series_games) except Pokémon Legends: Arceus and Pokémon Legends: Z-A.
* **Base Expansion Version**: A .gba file built from an unmodified `master` branch of `pokeemerald-expansion`.
* **Vanilla Emerald Version**: A .gba file built from an unmodified `master` branch of `pokeemerald`.
# Guidelines
A pull request meets the scope crtieria if:
* The feature does not belong to a category considered “not in scope” AND
* The feature belongs to a category conisred “in scope”
## In Scope Categories
1. **SS Species:** Adds Species that have appeared in a Showdown-supported title
2. **SS Moves:** Adds Moves and Move Animations that have appeared in a Showdown-supported title
3. **SS Abilities:** Adds Abilities that have appeared in a Showdown-supported title
4. **SS Items:** Adds Items that have appeared in a Showdown-supported title
5. **SS Gimmicks:** Adds Gimmicks that have appeared in a Showdown-supported title
6. **SS Battle Types:** Adds Special Battle Types that have appeared in a Showdown-supported title
7. **SS Battle Mechanics:** Add mechanical battle changes that have appeared in a Showdown-supported title
8. **Improve Battle AI:** Improve the Battle AI in a way that allows it to approach the skill and capability of a human competitive player
9. **Base Link Compatibility:** Link compatibility with base
10. **SS Overworld / Menu Updates:** Replicate overworld or menu changes from Showdown-supported Pokémon titles
11. **Speed Up:** Speed up the player experience of features found in base
12. **Compression:** Automatically compress assets
13. **Novel Experience:** Add a novel experience included in another Showdown Supported title
15. **Helper Features:** Eases the addition or inclusion of any of the aforementioned
## Not In Scope Categories
1. **Non-SS Species**: Adds Species that have NOT appeared in a Showdown-supported title
2. **Non-SS Moves**: Adds Moves and Move Animations that have NOT appeared in a Showdown-supported title
3. **Non-SS Abilities**: Adds Abilities that have NOT appeared in a Showdown-supported title
4. **Non-SS Items**: Adds Items that have NOT appeared in a Showdown-supported title
5. **Non-SS Gimmicks**: Adds Gimmicks that have NOT appeared in a Showdown-supported title
6. **Non-SS Battle Types**: Adds Special Battle Types that have NOT appeared in a Showdown-supported title
7. **Duplicate Feature UI**: Add functionality that duplicates the core functionality of an existing vanilla feature
8. **Vanilla Link Compatibility**: Link compatibility with vanilla
9. **External Program**: External programs
## Discussion Required Categories
Pull Requests that fall into this category should be brought up to maintainers, who will discuss and vote as to whether or not the feature is considered in scope. Considerations for acceptance may include invasiveness of implementation, popularity, ease of maintanence, etc.
1. **Developer Ease of Use:** Lowers barrier of entry for developers to use existing behavior
2. **Fangame Features:** Adds a popular feature from other fangames
3. **Popular Non-SS Features:** Exceptions can be made for uniquely popular or requested features (Drowsy, PLA Legend Plate, etc.)