From 4d37308d120cca180a7c0dee3e128c145dd7c907 Mon Sep 17 00:00:00 2001
From: Landon Curt Noll <github-mail@asthe.com>
Date: Sun, 30 Jun 2024 18:41:50 -0700
Subject: [PATCH] add draft FAQ about contributing deobfuscated code

---
 faq.html | 58 +++++++++++++++++++++++++++++++++++++++--
 faq.md   | 78 ++++++++++++++++++++++++++++++++++++++++++++++++++++++--
 2 files changed, 132 insertions(+), 4 deletions(-)

diff --git a/faq.html b/faq.html
index 02ca5f782..e486e7ea5 100644
--- a/faq.html
+++ b/faq.html
@@ -456,6 +456,7 @@ other inconsistencies with the original entry?</a></li>
 <li><a href="#faq5_5">5.5 - How may I correct or update IOCCC author information?</a></li>
 <li><a href="#faq5_6">5.6 - What should I do if I find a broken or wrong web link?</a></li>
 <li><a href="#faq5_7">5.7 - How may I support the IOCCC?</a></li>
+<li><a href="#faq5_8">5.8 - I deobfuscated some entry code, how may I contribute the source?</a></li>
 </ul>
 <h2 id="section-6---miscellaneous-ioccc">Section 6 - <a href="#faq6">Miscellaneous IOCCC</a></h2>
 <ul>
@@ -2456,8 +2457,61 @@ Nevertheless, it has been shown that receiving <strong>anonymous</strong> gifts
 provides the <a href="judges.html">IOCCC judges</a> with a nice dopamine
 boost, and happy <a href="judges.html">IOCCC judges</a> help make the IOCCC
 better for everyone. :-)</p>
-<p>If you wish to express your support, we suggest making an <strong>Anonymous</strong> gift
-via the <a href="https://www.amazon.com/hz/wishlist/ls/3HSNTEL8RQ1M0?ref_=wl_share">IOCCC Amazon wishlist</a>.</p>
+<p>If you wish to express your support and/or appreication or our
+efforts, we suggest making an <strong>Anonymous</strong> gift via the
+<a href="https://www.amazon.com/hz/wishlist/ls/3HSNTEL8RQ1M0?ref_=wl_share">IOCCC Amazon wishlist</a>.</p>
+<div id="faq5_8">
+<div id="deobfuscated">
+<h3 id="faq-5.8-i-deobfuscated-some-entry-code-how-may-i-contribute-the-source">FAQ 5.8: I deobfuscated some entry code, how may I contribute the source?</h3>
+</div>
+</div>
+<p>The <a href="judges.html">IOCCC judges</a> welcome those who wish to contribute
+a <strong>deobfuscated</strong> version of a winning IOCCC entry: from either
+the <a href="authors.html">author(s)</a> or from people such as
+yourself who are willing to contribute <strong>deobfuscated</strong> code.
+We also welcome contributions to improve existing <strong>deobfuscated</strong> code.</p>
+<p><strong>HISTORICAL NOTE</strong>: The IOCCC web site has shifted to a more
+educational theme: preferring to explain entries rather than hiding
+things under the guise of such information being a “<em>spoiler</em>”. We
+now use the term <strong>deobfuscated</strong> instead of “<em>spoiler</em>” for this reason.</p>
+<p>We ask that the <strong>deobfuscated</strong> code be identical to the
+functionality of the winning IOCCC entry code.</p>
+<p><strong>NOTE</strong>: Be aware that IOCCC entry code may contain <strong>extremely
+subtle and obscure side effects</strong> (i.e., features). Those wishing
+to contribute a <strong>deobfuscated</strong> version of code should <strong>strive
+to mimic</strong> the original (or existing <code>prog.c</code>code) IOCCC entry
+code as much as possible.</p>
+<p>To contribute your <strong>deobfuscated</strong> code, please open up a
+<a href="https://github.com/ioccc-src/temp-test-ioccc/discussions/new?category=show-and-tell">Show and tell new discussion</a>.
+with a title of the form:</p>
+<pre><code>    Enhancement: deobfuscated code for YYYY/dirname</code></pre>
+<p>where “<em>YYYY/dirname</em>” refers to the winning IOCCC entry for which you are de-obfuscating.</p>
+<p>In the <strong>body</strong> of your new discussion, <strong>PLEASE</strong> provide us with a <strong>URL</strong> of
+your <strong>deobfuscated</strong> code, along with whatever notes and/or comments you
+think might be helpful.</p>
+<p>If you are providing an improved version of some existing <strong>deobfuscated</strong> code, please
+mention that in the <strong>body</strong> of your new discussion as well.</p>
+<p>If there are <strong>limitations</strong> to how well the your <strong>deobfuscated</strong> code minics
+the original (or existing <code>prog.c</code>code) IOCCC entry code, <strong>PLEASE</strong> mention those <strong>limitations</strong>
+in the <strong>body</strong> of your new discussion as well.</p>
+<p>Any questions that may arise arise will be added as comments to the discussion.</p>
+<p><strong>SUGGESTION</strong>: <strong>PLEASE</strong> try to make your <strong>deobfuscated</strong> code readable. <strong>PLEASE</strong>
+add comments as needed to help the reader of your <strong>deobfuscated</strong> code understand it.</p>
+<p><strong>SUGGESTION</strong>: Where useful, consider providing, as <strong>C comments</strong>,
+code fragments of from the original (or existing <code>prog.c</code>code) IOCCC
+entry code. While it is <strong>NOT</strong> necessary to include the entire
+original code as <strong>C comments</strong>, including key parts from the
+original (or existing <code>prog.c</code>code) IOCCC entry code may be helpful
+to others who wish to read your <strong>deobfuscated</strong> code.</p>
+<p>If your <strong>deobfuscated</strong> is accepted (in some form), the <a href="judges.html">IOCCC judges</a>
+will be happy to <strong>thank you</strong> for your contribution in the
+<a href="thanks-for-help.html">Thanking people for their help</a> file.</p>
+<p>The <a href="judges.html">IOCCC judges</a> will do the rest of the work in integrate your
+<strong>deobfuscated</strong> code as an “<em>alt</em>” code for the entry <strong>AND</strong> will reference
+your <strong>deobfuscated</strong> code in the entry’s <code>index.html</code> file. We will be
+happy to include any whatever notes and/or comments from your new discussion
+that be prove helpful.</p>
+<p><strong>THANK YOU</strong> in advance for your willingness to assist!</p>
 <div id="faq6">
 <h2 id="section-6-miscellaneous-ioccc">Section 6: Miscellaneous IOCCC</h2>
 </div>
diff --git a/faq.md b/faq.md
index e9622f419..42bf71427 100644
--- a/faq.md
+++ b/faq.md
@@ -73,6 +73,7 @@ other inconsistencies with the original entry?](#faq4_3)
 - [5.5  - How may I correct or update IOCCC author information?](#faq5_5)
 - [5.6  - What should I do if I find a broken or wrong web link?](#faq5_6)
 - [5.7  - How may I support the IOCCC?](#faq5_7)
+- [5.8 - I deobfuscated some entry code, how may I contribute the source?](#faq5_8)
 
 
 ## Section  6 - [Miscellaneous IOCCC](#faq6)
@@ -2996,8 +2997,81 @@ provides the [IOCCC judges](judges.html) with a nice dopamine
 boost, and happy [IOCCC judges](judges.html) help make the IOCCC
 better for everyone. :-)
 
-If you wish to express your support, we suggest making an **Anonymous** gift
-via the [IOCCC Amazon wishlist](https://www.amazon.com/hz/wishlist/ls/3HSNTEL8RQ1M0?ref_=wl_share).
+If you wish to express your support and/or appreication or our
+efforts, we suggest making an **Anonymous** gift via the
+[IOCCC Amazon wishlist](https://www.amazon.com/hz/wishlist/ls/3HSNTEL8RQ1M0?ref_=wl_share).
+
+
+<div id="faq5_8">
+<div id="deobfuscated">
+### FAQ 5.8: I deobfuscated some entry code, how may I contribute the source?
+</div>
+</div>
+
+The [IOCCC judges](judges.html) welcome those who wish to contribute
+a **deobfuscated** version of a winning IOCCC entry: from either
+the [author&#x28;s&#x29;](authors.html) or from people such as
+yourself who are willing to contribute **deobfuscated** code.
+We also welcome contributions to improve existing **deobfuscated** code.
+
+**HISTORICAL NOTE**: The IOCCC web site has shifted to a more
+educational theme: preferring to explain entries rather than hiding
+things under the guise of such information being a "_spoiler_".  We
+now use the term **deobfuscated** instead of "_spoiler_" for this reason.
+
+We ask that the **deobfuscated** code be identical to the
+functionality of the winning IOCCC entry code.
+
+**NOTE**: Be aware that IOCCC entry code may contain **extremely
+subtle and obscure side effects** (i.e., features).  Those wishing
+to contribute a **deobfuscated** version of code should **strive
+to mimic** the original (or existing `prog.c`code) IOCCC entry
+code as much as possible.
+
+To contribute your **deobfuscated** code, please open up a
+[Show and tell new discussion](https://github.com/ioccc-src/temp-test-ioccc/discussions/new?category=show-and-tell).
+with a title of the form:
+
+```
+    Enhancement: deobfuscated code for YYYY/dirname
+```
+
+where "_YYYY/dirname_" refers to the winning IOCCC entry for which you are de-obfuscating.
+
+In the **body** of your new discussion, **PLEASE** provide us with a **URL** of
+your **deobfuscated** code, along with whatever notes and/or comments you
+think might be helpful.
+
+If you are providing an improved version of some existing **deobfuscated** code, please
+mention that in the **body** of your new discussion as well.
+
+If there are **limitations** to how well the your **deobfuscated** code minics
+the original (or existing `prog.c`code) IOCCC entry code, **PLEASE** mention those **limitations**
+in the **body** of your new discussion as well.
+
+Any questions that may arise arise will be added as comments to the discussion.
+
+**SUGGESTION**: **PLEASE** try to make your **deobfuscated** code readable.  **PLEASE**
+add comments as needed to help the reader of your **deobfuscated** code understand it.
+
+**SUGGESTION**: Where useful, consider providing, as **C comments**,
+code fragments of from the original (or existing `prog.c`code) IOCCC
+entry code.  While it is **NOT** necessary to include the entire
+original code as **C comments**, including key parts from the
+original (or existing `prog.c`code) IOCCC entry code may be helpful
+to others who wish to read your **deobfuscated** code.
+
+If your **deobfuscated** is accepted (in some form), the [IOCCC judges](judges.html)
+will be happy to **thank you** for your contribution in the
+[Thanking people for their help](thanks-for-help.html) file.
+
+The [IOCCC judges](judges.html) will do the rest of the work in integrate your
+ **deobfuscated** code as an "_alt_" code for the entry **AND** will reference
+ your **deobfuscated** code in the entry's `index.html` file.  We will be
+ happy to include any whatever notes and/or comments from your new discussion
+ that be prove helpful.
+
+ **THANK YOU** in advance for your willingness to assist!
 
 
 <div id="faq6">