From 96438f6e668ed07705ea71eb6be13876ff82e372 Mon Sep 17 00:00:00 2001 From: suspect15 <106546659+suspect15@users.noreply.github.com> Date: Sat, 23 Aug 2025 17:28:13 -0400 Subject: [PATCH 1/4] draft credit guidance --- docs/.vitepress/config/en.ts | 4 +++ docs/.vitepress/config/es.ts | 4 +++ docs/.vitepress/config/pt.ts | 4 +++ docs/guidelines/developers/credit.md | 50 ++++++++++++++++++++++++++++ 4 files changed, 62 insertions(+) create mode 100644 docs/guidelines/developers/credit.md diff --git a/docs/.vitepress/config/en.ts b/docs/.vitepress/config/en.ts index 9d43a53f..13d565d6 100644 --- a/docs/.vitepress/config/en.ts +++ b/docs/.vitepress/config/en.ts @@ -184,6 +184,10 @@ function sidebarGuidelines(): DefaultTheme.SidebarItem[] { text: "Handling Tickets", link: "/guidelines/developers/handling-tickets", }, + { + text: "Set and Achievement Contribution Credit", + link: "/guidelines/developers/credit", + }, ], }, { diff --git a/docs/.vitepress/config/es.ts b/docs/.vitepress/config/es.ts index e88511d2..02256a27 100644 --- a/docs/.vitepress/config/es.ts +++ b/docs/.vitepress/config/es.ts @@ -188,6 +188,10 @@ function sidebarGuidelines(): DefaultTheme.SidebarItem[] { // text: "Manejo de tickets", // link: "/es/guidelines/developers/handling-tickets", // }, + // { + // text: "Set and Achievement Contribution Credit", + // link: "/guidelines/developers/credit", + // }, ], }, { diff --git a/docs/.vitepress/config/pt.ts b/docs/.vitepress/config/pt.ts index 3b23809f..878f5323 100644 --- a/docs/.vitepress/config/pt.ts +++ b/docs/.vitepress/config/pt.ts @@ -187,6 +187,10 @@ function sidebarGuidelines(): DefaultTheme.SidebarItem[] { // text: "Tratamento de Tickets", // link: "/pt/guidelines/developers/handling-tickets", // }, + // { + // text: "Set and Achievement Contribution Credit", + // link: "/guidelines/developers/credit", + // }, // ], // }, // { diff --git a/docs/guidelines/developers/credit.md b/docs/guidelines/developers/credit.md new file mode 100644 index 00000000..c745e42c --- /dev/null +++ b/docs/guidelines/developers/credit.md @@ -0,0 +1,50 @@ +--- +title: Set and Achievement Credit +description: Guidelines for when contribution credit on RetroAchievements is appropriate for the different types of credit that can be assigned. +--- + +# Set and Achievement Contribution Credit + +[[toc]] + +## Purpose of Contribution Credit +There are many different aspects to creating achievements for RetroAchievements. An achievement set is comprised of a set's design, code, artwork, writing, and stability testing. In some cases, a set's author accomplishes all of these tasks, but often times, others make important contributions to a set that merits recognition and credit. + +This document establishes the guidelines for when credit may be assigned to contributors for each creditable task. Developers may assign task credit to users in accordance with this document. + +Assigning credit to people who did not provide significant and verifiable contributions is considered abuse of the credit system. + +When in doubt, contact the [QATeam](https://retroachievements.org/user/QATeam) account to seek clarification. + +## How to Assign Credit +Credit is assigned to people via the management app. Set-wide task credit is assigned on the **Set Credit**s** tab by clicking on the **Add contribution** credit button. Individual achievement credit can be assigned in bulk by selecting desired achievements on the **Achievements** tab then clicking **Bulk add credit**. + +## Set Credit +### Authorship +Authorship is automatically conferred when a developer is the author of at least one promoted achievement in a set. Authorship is automatically determined and cannot be altered by developers. + +### Mastery Icon Credit +Master icon credit shall be assigned to the person who created the set's current mastery icon. When a mastery icon is replaced, assign credit to the new icon's creator and set the **Date Credited** as the day the icon is replaced. In cases where there are multiple contributors to a mastery icon, the person who is responsible for producing the icon's focal point shall be assigned credit. Minor changes such as altering brightness, adding a border, or other minor changes where significant previous icon artwork is retained is insufficient to be awarded mastery icon credit. + +## Individual Achievement Credit +### Badge Artwork +Badge artwork credit shall be assigned to the person who created the current achievement badge. When an achievement badge is replaced, assign credit to the new badge's creator and set the **Date Credited** as the day the badge is replaced. In cases where there are multiple contributors to an achievement badge, the person who is responsible for producing the badge's focal point shall be assigned credit. Minor changes such as altering brightness, adding a border, or other minor changes where significant previous badge artwork is retained is insufficient to be awarded badge artwork credit. + +### Design +Achievement design credit shall be assigned, at the set developer's discretion, to the person responsible for providing the achievement's concept. Often times design concept evolve either during the set design phase or during development. The set developer is responsible for determining who shall be assigned achievement design credit. + +### Logic +Achievement logic credit is automatically assigned when an achievement is uploaded. It may be reassigned to another developer if it is **fully recoded** during a revision or ticket resolution. Correcting relatively minor issues is insufficient to assign logic credit. + +### Testing +Achievement testing credit shall be assigned per Play Tester team guidance when testing occurs by through the Play Tester team process. For testing by non-Play Tester team members, but in direct coordination with a developer, the set developer shall use the following guidelines to determine if testing credit is appropriate: +- Testing occurred prior to the achievement being first promoted +- Testing was thorough and exhaustive meaning proper function was validated through multiple unlock attempts including expected situations and edge cases +- Issues discovered were corrected by the developer prior to promotion + +### Writing +Achievement writing shall be assigned per Writing Team guidance when writing updates occurs through the Writing Team process. For writing updates by non-Writing Team members, the set developer shall determine if writing credit is appropriate based upon the following guidelines: +- Complete description rewrites +- Description corrections that rectify significant grammatical errors +- Description updates that remove use of unnecessary parenthesis or brackets +- General title or description improvements deemed credit worthy by the set developer From 1e59d1393c621678c5707d13d755ed69580cde16 Mon Sep 17 00:00:00 2001 From: Nepiki <76693803+Nepiki@users.noreply.github.com> Date: Sun, 24 Aug 2025 19:42:15 +0200 Subject: [PATCH 2/4] Update Writing Team credit --- docs/guidelines/developers/credit.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/docs/guidelines/developers/credit.md b/docs/guidelines/developers/credit.md index c745e42c..6bcbdb5d 100644 --- a/docs/guidelines/developers/credit.md +++ b/docs/guidelines/developers/credit.md @@ -44,7 +44,15 @@ Achievement testing credit shall be assigned per Play Tester team guidance when ### Writing Achievement writing shall be assigned per Writing Team guidance when writing updates occurs through the Writing Team process. For writing updates by non-Writing Team members, the set developer shall determine if writing credit is appropriate based upon the following guidelines: -- Complete description rewrites -- Description corrections that rectify significant grammatical errors -- Description updates that remove use of unnecessary parenthesis or brackets -- General title or description improvements deemed credit worthy by the set developer +- Completely new titles that are not simple capitalization/grammar fixes or adding a word +- Adding significant polish to descriptions to make them more appealing + - ✅ Defeat the boss in Stage 1-1 damageless => Defeat Beelzebub in stage 1-1 "The Castle" without taking damage + - ✅ Obtain the Boulder Badge => Defeat Brock at the Pewter City Gym and obtain the Boulder Badge + - ❌ Find your missing fish and clear The Waterworks => Clear Stage 1 "The Waterworks" +- Making grammar/capitalization fixes and rewrites that are significant enough to give descriptions more clarity + - ✅ Defeat Stage 1 boss without die => Defeat the boss of Stage 1 without dying + - ✅ Beat Firemanv3 With S Rank => Defeat FireManV3 with an S rank + - ✅ Clear Stage 1 (Hard mode, no deaths) => Clear Stage 1 on Hard mode without dying + - ❌ Open all chests in Moon Boon Cavern => Open every chest in Moon Boon Cavern + - ❌ Defeat boss in Stage 1 => Defeat the boss in Stage 1 + - ❌ Clear Stage 1 [Hard] => Clear Stage 1 on Hard From 459058f7b5731ad84a0152f5585c1b709a9c8f22 Mon Sep 17 00:00:00 2001 From: suspect15 <106546659+suspect15@users.noreply.github.com> Date: Tue, 26 Aug 2025 06:16:15 -0400 Subject: [PATCH 3/4] minor update to design --- docs/guidelines/developers/credit.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guidelines/developers/credit.md b/docs/guidelines/developers/credit.md index c745e42c..ee27b1fa 100644 --- a/docs/guidelines/developers/credit.md +++ b/docs/guidelines/developers/credit.md @@ -31,7 +31,7 @@ Master icon credit shall be assigned to the person who created the set's current Badge artwork credit shall be assigned to the person who created the current achievement badge. When an achievement badge is replaced, assign credit to the new badge's creator and set the **Date Credited** as the day the badge is replaced. In cases where there are multiple contributors to an achievement badge, the person who is responsible for producing the badge's focal point shall be assigned credit. Minor changes such as altering brightness, adding a border, or other minor changes where significant previous badge artwork is retained is insufficient to be awarded badge artwork credit. ### Design -Achievement design credit shall be assigned, at the set developer's discretion, to the person responsible for providing the achievement's concept. Often times design concept evolve either during the set design phase or during development. The set developer is responsible for determining who shall be assigned achievement design credit. +Achievement design credit shall be assigned, at the set developer's discretion, to the person responsible for providing the achievement's concept. Often times, design concepts evolve either during the set design phase or during development, which may make determining credit difficult. The set developer is responsible for determining who shall be assigned achievement design credit. ### Logic Achievement logic credit is automatically assigned when an achievement is uploaded. It may be reassigned to another developer if it is **fully recoded** during a revision or ticket resolution. Correcting relatively minor issues is insufficient to assign logic credit. From 69dec28f657ae1d38b47bc7ca41a339a94b1f341 Mon Sep 17 00:00:00 2001 From: Nepiki <76693803+Nepiki@users.noreply.github.com> Date: Sun, 28 Sep 2025 01:46:12 +0200 Subject: [PATCH 4/4] Update credit.md Few grammar/typo fixes --- docs/guidelines/developers/credit.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/guidelines/developers/credit.md b/docs/guidelines/developers/credit.md index 852ec137..0caaf98c 100644 --- a/docs/guidelines/developers/credit.md +++ b/docs/guidelines/developers/credit.md @@ -17,14 +17,14 @@ Assigning credit to people who did not provide significant and verifiable contri When in doubt, contact the [QATeam](https://retroachievements.org/user/QATeam) account to seek clarification. ## How to Assign Credit -Credit is assigned to people via the management app. Set-wide task credit is assigned on the **Set Credit**s** tab by clicking on the **Add contribution** credit button. Individual achievement credit can be assigned in bulk by selecting desired achievements on the **Achievements** tab then clicking **Bulk add credit**. +Credit is assigned to people via the management app. Set-wide task credit is assigned on the **Set Credits** tab by clicking on the **Add contribution** credit button. Individual achievement credit can be assigned in bulk by selecting desired achievements on the **Achievements** tab, then clicking **Bulk add credit**. ## Set Credit ### Authorship Authorship is automatically conferred when a developer is the author of at least one promoted achievement in a set. Authorship is automatically determined and cannot be altered by developers. ### Mastery Icon Credit -Master icon credit shall be assigned to the person who created the set's current mastery icon. When a mastery icon is replaced, assign credit to the new icon's creator and set the **Date Credited** as the day the icon is replaced. In cases where there are multiple contributors to a mastery icon, the person who is responsible for producing the icon's focal point shall be assigned credit. Minor changes such as altering brightness, adding a border, or other minor changes where significant previous icon artwork is retained is insufficient to be awarded mastery icon credit. +Mastery icon credit shall be assigned to the person who created the set's current mastery icon. When a mastery icon is replaced, assign credit to the new icon's creator and set the **Date Credited** as the day the icon is replaced. In cases where there are multiple contributors to a mastery icon, the person who is responsible for producing the icon's focal point shall be assigned credit. Minor changes such as altering brightness, adding a border, or other minor changes where significant previous icon artwork is retained is insufficient to be awarded mastery icon credit. ## Individual Achievement Credit ### Badge Artwork @@ -37,7 +37,7 @@ Achievement design credit shall be assigned, at the set developer's discretion, Achievement logic credit is automatically assigned when an achievement is uploaded. It may be reassigned to another developer if it is **fully recoded** during a revision or ticket resolution. Correcting relatively minor issues is insufficient to assign logic credit. ### Testing -Achievement testing credit shall be assigned per Play Tester team guidance when testing occurs by through the Play Tester team process. For testing by non-Play Tester team members, but in direct coordination with a developer, the set developer shall use the following guidelines to determine if testing credit is appropriate: +Achievement testing credit shall be assigned per Playtester team guidance when testing occurs by through the Playtester team process. For testing by non-Playtester team members, but in direct coordination with a developer, the set developer shall use the following guidelines to determine if testing credit is appropriate: - Testing occurred prior to the achievement being first promoted - Testing was thorough and exhaustive meaning proper function was validated through multiple unlock attempts including expected situations and edge cases - Issues discovered were corrected by the developer prior to promotion