From f41fdbff6d2894edeb66d644c915a32f7388da01 Mon Sep 17 00:00:00 2001 From: pkmnsnfrn Date: Thu, 21 Nov 2024 12:59:51 -0800 Subject: [PATCH 1/8] First pass at scope doc and updated PR tempalte --- .github/pull_request_template.md | 4 +++ docs/scope.md | 53 ++++++++++++++++++++++++++++++++ 2 files changed, 57 insertions(+) create mode 100644 docs/scope.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 2259d399c9..6a74e9fbd5 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,5 +1,9 @@ + + + + ## Description diff --git a/docs/scope.md b/docs/scope.md new file mode 100644 index 0000000000..c31cbb37d3 --- /dev/null +++ b/docs/scope.md @@ -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.) From cd11fcc2a56e9413dc68adde3cdda575143123b0 Mon Sep 17 00:00:00 2001 From: psf <77138753+pkmnsnfrn@users.noreply.github.com> Date: Thu, 21 Nov 2024 14:06:41 -0800 Subject: [PATCH 2/8] Apply suggestions from code review Co-authored-by: Pawkkie <61265402+Pawkkie@users.noreply.github.com> --- docs/scope.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/scope.md b/docs/scope.md index c31cbb37d3..01056be7c3 100644 --- a/docs/scope.md +++ b/docs/scope.md @@ -1,10 +1,10 @@ # 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. +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 an opened PR is within scope, this does not mean it will be merged, as acceptance criteria 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. +* **Showdown Supported (SS)**: A core series game who's 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`. @@ -13,7 +13,7 @@ This document is a guide for contributors and Senate to decide if a feature is w 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” +* The feature belongs to a category considered “in scope” ## In Scope Categories @@ -23,13 +23,13 @@ A pull request meets the scope crtieria if: 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 +7. **SS Battle Mechanics:** Adds 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 +13. **Novel Experience:** Adds 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 @@ -40,13 +40,13 @@ A pull request meets the scope crtieria if: 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 +7. **Duplicate Feature UI**: Adds 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. +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 maintenance, 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 From aae6e3f903bc9f14b66faaf672d3f7cbf0281ca5 Mon Sep 17 00:00:00 2001 From: psf <77138753+pkmnsnfrn@users.noreply.github.com> Date: Thu, 21 Nov 2024 15:14:05 -0800 Subject: [PATCH 3/8] Update docs/scope.md Co-authored-by: Eduardo Quezada --- docs/scope.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/scope.md b/docs/scope.md index 01056be7c3..5db9102ca8 100644 --- a/docs/scope.md +++ b/docs/scope.md @@ -7,7 +7,7 @@ This document is a guide for contributors and Senate to decide if a feature is w * **Showdown Supported (SS)**: A core series game who's 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`. +* **Vanilla Emerald Version**: A .gba file built from an unmodified `master` branch of pret's `pokeemerald`. # Guidelines From 4ddcef8944404172c0bae53f3f72dda8fb1abf94 Mon Sep 17 00:00:00 2001 From: psf <77138753+pkmnsnfrn@users.noreply.github.com> Date: Sun, 1 Dec 2024 17:17:55 -0800 Subject: [PATCH 4/8] Update docs/scope.md Co-authored-by: Bassoonian --- docs/scope.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/scope.md b/docs/scope.md index 5db9102ca8..21f401b29e 100644 --- a/docs/scope.md +++ b/docs/scope.md @@ -11,7 +11,7 @@ This document is a guide for contributors and Senate to decide if a feature is w # Guidelines -A pull request meets the scope crtieria if: +A pull request meets the scope criteria if: * The feature does not belong to a category considered “not in scope” AND * The feature belongs to a category considered “in scope” From 65587be4d75e3f38732e6797bce1b1ba54bdf1d3 Mon Sep 17 00:00:00 2001 From: psf <77138753+pkmnsnfrn@users.noreply.github.com> Date: Mon, 2 Dec 2024 09:26:48 -0800 Subject: [PATCH 5/8] Update scope.md --- docs/scope.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/scope.md b/docs/scope.md index 21f401b29e..896be8e280 100644 --- a/docs/scope.md +++ b/docs/scope.md @@ -5,8 +5,8 @@ This document is a guide for contributors and Senate to decide if a feature is w # Definitions * **Showdown Supported (SS)**: A core series game who's 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`. + * Notably, this is every [core series game](https://bulbapedia.bulbagarden.net/wiki/Core_series#List_of_core_series_games) except Pokémon Legends: Arceus. +* **Base Expansion Version**: "A .gba file built from an unmodified `master` or `upcoming` branch of `pokeemerald-expansion`. * **Vanilla Emerald Version**: A .gba file built from an unmodified `master` branch of pret's `pokeemerald`. # Guidelines From 9b06f7e4924604b8f69619009829ab0ba1dee437 Mon Sep 17 00:00:00 2001 From: psf <77138753+pkmnsnfrn@users.noreply.github.com> Date: Mon, 2 Dec 2024 11:01:49 -0800 Subject: [PATCH 6/8] Update scope.md --- docs/scope.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/scope.md b/docs/scope.md index 896be8e280..1bec4f2db7 100644 --- a/docs/scope.md +++ b/docs/scope.md @@ -41,8 +41,7 @@ A pull request meets the scope criteria if: 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**: Adds functionality that duplicates the core functionality of an existing vanilla feature -8. **Vanilla Link Compatibility**: Link compatibility with vanilla -9. **External Program**: External programs +8. **Vanilla Link Compatibility**: Link compatibility with vanilla ## Discussion Required Categories @@ -51,3 +50,5 @@ Pull Requests that fall into this category should be brought up to maintainers, 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.) +4. **External Program**: External programs like poryscript, porymoves, etc. + From 3cd89c6e1961a7da6c653e3c311e191da4cee800 Mon Sep 17 00:00:00 2001 From: pkmnsnfrn Date: Mon, 2 Dec 2024 11:49:06 -0800 Subject: [PATCH 7/8] Added scope document link to website --- docs/SUMMARY.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index ac4698fdc3..168a8b5e51 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -64,3 +64,4 @@ - [Version 0.9.0](changelogs/0.9.x/0.9.0.md) - [Team Procedures]() - [How to make an Expansion version](team_procedures/expansion_versions.md) + - [Scope Guidelines](docs/scope.md) From 0d31f3b972c0469114302c6e7cc2cc18284d64e3 Mon Sep 17 00:00:00 2001 From: pkmnsnfrn Date: Mon, 2 Dec 2024 11:50:21 -0800 Subject: [PATCH 8/8] Fixed broken link to scope doc --- docs/SUMMARY.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 168a8b5e51..e0f2a62bed 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -64,4 +64,4 @@ - [Version 0.9.0](changelogs/0.9.x/0.9.0.md) - [Team Procedures]() - [How to make an Expansion version](team_procedures/expansion_versions.md) - - [Scope Guidelines](docs/scope.md) + - [Scope Guidelines](scope.md)