complete our review of the IOCCC rules and IOCCC guidelines
A review of the IOCCC rules and IOCCC guidelines, @xexyl, on 2025 March 4 would be very much welcome.
This commit is contained in:
1 parent
37ba5f892b
commit
29408c8293
4 files changed
+694
-638
No files matched your search
+289
-299
File diff suppressed because it is too large.
Load diff
+347
-307
File diff suppressed because it is too large.
Load diff
+25
-13
@@ -600,6 +600,13 @@ judges</a> do not think you uploaded a duplicate into a
|
||||
wrong slot by mistake.
|
||||
</p>
|
||||
<p class="leftbar">
|
||||
Uploading a tarball not formed by <code>mkiocccentry(1)</code> puts you at a very big risk of
|
||||
violating <a href="rules.html#rule17">Rule 17</a>, especially as <code>mkiocccentry(1)</code> does a
|
||||
great number of things that are required, and it also runs many checks, and if
|
||||
any of those checks fail, you are at a very great risk of having your submission
|
||||
rejected for violating <a href="rules.html#rule17">Rule 17</a>.
|
||||
</p>
|
||||
<p class="leftbar">
|
||||
See also <a href="#rule13">Rule 12</a>.
|
||||
</p>
|
||||
<p>Jump to: <a href="#">top</a></p>
|
||||
@@ -695,7 +702,8 @@ perhaps as much as a few days, for your registration to be processed and for tha
|
||||
<p class="leftbar">
|
||||
Those who <a href="register.html">register</a> while the contest status is <strong><a href="../faq.html#pending">pending</a></strong>
|
||||
will receive their email (containing their <a href="https://submit.ioccc.org">submit server</a> <strong>Username</strong>
|
||||
and <strong>Initial password</strong>), much later: few days around the time when the contest status becomes <strong><a href="../faq.html#open">open</a></strong>.
|
||||
and <strong>Initial password</strong>), much later: usually a few days around the time when the contest status
|
||||
becomes <strong><a href="../faq.html#open">open</a></strong>.
|
||||
</p>
|
||||
<p class="leftbar">
|
||||
Once that email you your <strong>Username</strong> and <strong>Initial password</strong> is sent, you
|
||||
@@ -703,20 +711,21 @@ will have 72 hours to <a href="pw-change.html">change your submit server initial
|
||||
</p>
|
||||
<p class="leftbar">
|
||||
If you do not change your <strong>Initial password</strong> in time, you will have
|
||||
to <a href="contact.html">contact an IOCCC judge</a> by email and ask them to reset
|
||||
to <a href="../contact.html">contact an IOCCC judge</a> by email and ask them to reset
|
||||
your password. Not only is this a hassle for everyone involved, it will
|
||||
delay your IOCCC registration process, perhaps by a number of days that
|
||||
<code>egrep(1)</code> would be able to pattern match. By <code>egrep(1)</code>, we refer to the
|
||||
long standing <strong>UNIX</strong> utility that should just run and <strong>NOT</strong> whine about
|
||||
the command being deprecated.
|
||||
the command being allegedly deprecated.
|
||||
</p>
|
||||
<p class="leftbar">
|
||||
Because it takes time (maybe even a few days) for an <a href="../judges.html">IOCCC judge</a>
|
||||
to process your registration and email you your initial login and password,
|
||||
you should <strong>MAKE SURE</strong> you give yourself enough time before the contest closes.
|
||||
In other words, <strong>DO NOT WAIT UNTIL THE FINAL DAYS</strong> of the contest to register!
|
||||
The <a href="../judges.html">IOCCC judges</a> are <strong>NOT</strong> responsible for delayed or lost email,
|
||||
or for those who wait until the last minute to try to register!
|
||||
Because it takes time (maybe even a few days) to process your registration
|
||||
and for the server to email you your initial login and password, you
|
||||
should <strong>MAKE SURE</strong> you give yourself enough time to register well
|
||||
before the contest closes. In other words, <strong>DO NOT WAIT UNTIL THE FINAL DAYS</strong>
|
||||
of the contest to register! The <a href="../judges.html">IOCCC judges</a>
|
||||
are <strong>NOT</strong> responsible for delayed or lost email, or for those who wait
|
||||
until the last minute to try to register!
|
||||
</p>
|
||||
<p class="leftbar">
|
||||
See the
|
||||
@@ -795,7 +804,7 @@ detail that ownership</strong> (i.e., who owns what) <strong><em>AND</em> docume
|
||||
permission you obtained</strong> in your <code>remarks.md</code> file.
|
||||
</p>
|
||||
<p class="leftbar">
|
||||
Please note that <a href="https://github.com/ioccc-src/mkiocccentry">mkiocccentry repo tools</a>
|
||||
Please note that <a href="https://github.com/ioccc-src/mkiocccentry">mkiocccentry toolkit</a>
|
||||
are <strong>NOT</strong> original works, unless of course you’re the respective authors, in
|
||||
which case they are original. :-)
|
||||
</p>
|
||||
@@ -822,7 +831,7 @@ and test your submission. These tools may include, but are not limited
|
||||
to code generators, code analysis tools, static code analysis tools,
|
||||
runtime analysis tools, machine learning tools, natural language models,
|
||||
code copilot tools, so-called AI services, large language models, etc.
|
||||
If you do make use of such tools, then we <strong>ENCOURAGE you to describe
|
||||
If you do make use of such tools or services, then we <strong>ENCOURAGE you to describe
|
||||
how you used such tools</strong> in your <code>remarks.md</code> file.
|
||||
</p>
|
||||
<p class="leftbar">
|
||||
@@ -1032,10 +1041,13 @@ current version of the <code>mkiocccentry(1)</code> tool would produce. They mus
|
||||
also pass the tests performed by the current version of <code>chkentry(1)</code>.
|
||||
</p>
|
||||
<p class="leftbar">
|
||||
The <code>Makefile</code> must <strong>NOT</strong> be empty.
|
||||
The required <code>Makefile</code> must <strong>NOT</strong> be empty.
|
||||
</p>
|
||||
<p class="leftbar">
|
||||
The <code>remarks.md</code> must <strong>NOT</strong> be empty.
|
||||
The required <code>remarks.md</code> must <strong>NOT</strong> be empty.
|
||||
</p>
|
||||
<p class="leftbar">
|
||||
You may <strong>NOT</strong> submit a tarball created by the <code>-d</code> or <code>-s seed</code> option of <code>mkiocccentry(1)</code>.
|
||||
</p>
|
||||
<h3 id="tldr-rule-17---use-mkiocccentry1-to-form-your-submission">TL;DR Rule 17 - Use <code>mkiocccentry(1)</code> to form your submission</h3>
|
||||
<p class="leftbar">
|
||||
|
||||
+33
-19
@@ -230,6 +230,14 @@ judges](../judges.html) do not think you uploaded a duplicate into a
|
||||
wrong slot by mistake.
|
||||
</p>
|
||||
|
||||
<p class="leftbar">
|
||||
Uploading a tarball not formed by `mkiocccentry(1)` puts you at a very big risk of
|
||||
violating [Rule 17](rules.html#rule17), especially as `mkiocccentry(1)` does a
|
||||
great number of things that are required, and it also runs many checks, and if
|
||||
any of those checks fail, you are at a very great risk of having your submission
|
||||
rejected for violating [Rule 17](rules.html#rule17).
|
||||
</p>
|
||||
|
||||
<p class="leftbar">
|
||||
See also [Rule 12](#rule13).
|
||||
</p>
|
||||
@@ -371,7 +379,8 @@ perhaps as much as a few days, for your registration to be processed and for tha
|
||||
<p class="leftbar">
|
||||
Those who [register](register.html) while the contest status is **[pending](../faq.html#pending)**
|
||||
will receive their email (containing their [submit server](https://submit.ioccc.org) **Username**
|
||||
and **Initial password**), much later: few days around the time when the contest status becomes **[open](../faq.html#open)**.
|
||||
and **Initial password**), much later: usually a few days around the time when the contest status
|
||||
becomes **[open](../faq.html#open)**.
|
||||
</p>
|
||||
|
||||
<p class="leftbar">
|
||||
@@ -381,21 +390,22 @@ will have 72 hours to [change your submit server initial password](pw-change.htm
|
||||
|
||||
<p class="leftbar">
|
||||
If you do not change your **Initial password** in time, you will have
|
||||
to [contact an IOCCC judge](contact.html) by email and ask them to reset
|
||||
to [contact an IOCCC judge](../contact.html) by email and ask them to reset
|
||||
your password. Not only is this a hassle for everyone involved, it will
|
||||
delay your IOCCC registration process, perhaps by a number of days that
|
||||
`egrep(1)` would be able to pattern match. By `egrep(1)`, we refer to the
|
||||
long standing **UNIX** utility that should just run and **NOT** whine about
|
||||
the command being deprecated.
|
||||
the command being allegedly deprecated.
|
||||
</p>
|
||||
|
||||
<p class="leftbar">
|
||||
Because it takes time (maybe even a few days) for an [IOCCC judge](../judges.html)
|
||||
to process your registration and email you your initial login and password,
|
||||
you should **MAKE SURE** you give yourself enough time before the contest closes.
|
||||
In other words, **DO NOT WAIT UNTIL THE FINAL DAYS** of the contest to register!
|
||||
The [IOCCC judges](../judges.html) are **NOT** responsible for delayed or lost email,
|
||||
or for those who wait until the last minute to try to register!
|
||||
Because it takes time (maybe even a few days) to process your registration
|
||||
and for the server to email you your initial login and password, you
|
||||
should **MAKE SURE** you give yourself enough time to register well
|
||||
before the contest closes. In other words, **DO NOT WAIT UNTIL THE FINAL DAYS**
|
||||
of the contest to register! The [IOCCC judges](../judges.html)
|
||||
are **NOT** responsible for delayed or lost email, or for those who wait
|
||||
until the last minute to try to register!
|
||||
</p>
|
||||
|
||||
<p class="leftbar">
|
||||
@@ -506,7 +516,7 @@ permission you obtained** in your `remarks.md` file.
|
||||
</p>
|
||||
|
||||
<p class="leftbar">
|
||||
Please note that [mkiocccentry repo tools](https://github.com/ioccc-src/mkiocccentry)
|
||||
Please note that [mkiocccentry toolkit](https://github.com/ioccc-src/mkiocccentry)
|
||||
are **NOT** original works, unless of course you're the respective authors, in
|
||||
which case they are original. :-)
|
||||
</p>
|
||||
@@ -517,10 +527,10 @@ would probably violate a number of rules. :-)
|
||||
</p>
|
||||
|
||||
<p class="leftbar">
|
||||
- [mkioccentry(1)](https://github.com/ioccc-src/mkiocccentry/blob/master/mkiocccentry.c)
|
||||
- [iooccsize(1)](https://github.com/ioccc-src/mkiocccentry/blob/master/iocccsize.c)
|
||||
- [chkentry(1)](https://github.com/ioccc-src/mkiocccentry/blob/master/chkentry.c)
|
||||
- [txzchk(1)](https://github.com/ioccc-src/mkiocccentry/blob/master/txzchk.c)
|
||||
- [mkioccentry(1)](https://github.com/ioccc-src/mkiocccentry/blob/master/mkiocccentry.c)
|
||||
- [iooccsize(1)](https://github.com/ioccc-src/mkiocccentry/blob/master/iocccsize.c)
|
||||
- [chkentry(1)](https://github.com/ioccc-src/mkiocccentry/blob/master/chkentry.c)
|
||||
- [txzchk(1)](https://github.com/ioccc-src/mkiocccentry/blob/master/txzchk.c)
|
||||
- [jparse repo as cloned by the mkiocccentry repo](https://github.com/xexyl/jparse)
|
||||
- [dbg repo as cloned by the mkiocccentry repo](https://github.com/lcn2/dbg)
|
||||
- [dyn_array repo as cloned by the mkiocccentry repo](https://github.com/lcn2/dyn_array)
|
||||
@@ -534,7 +544,7 @@ and test your submission. These tools may include, but are not limited
|
||||
to code generators, code analysis tools, static code analysis tools,
|
||||
runtime analysis tools, machine learning tools, natural language models,
|
||||
code copilot tools, so-called AI services, large language models, etc.
|
||||
If you do make use of such tools, then we **ENCOURAGE you to describe
|
||||
If you do make use of such tools or services, then we **ENCOURAGE you to describe
|
||||
how you used such tools** in your `remarks.md` file.
|
||||
</p>
|
||||
|
||||
@@ -823,11 +833,15 @@ also pass the tests performed by the current version of `chkentry(1)`.
|
||||
</p>
|
||||
|
||||
<p class="leftbar">
|
||||
The `Makefile` must **NOT** be empty.
|
||||
The required `Makefile` must **NOT** be empty.
|
||||
</p>
|
||||
|
||||
<p class="leftbar">
|
||||
The `remarks.md` must **NOT** be empty.
|
||||
The required `remarks.md` must **NOT** be empty.
|
||||
</p>
|
||||
|
||||
<p class="leftbar">
|
||||
You may **NOT** submit a tarball created by the `-d` or `-s seed` option of `mkiocccentry(1)`.
|
||||
</p>
|
||||
|
||||
|
||||
@@ -891,14 +905,14 @@ The `remarks.md` file, a required non-empty file, must be written in
|
||||
</p>
|
||||
|
||||
<p class="leftbar">
|
||||
We currently use [pandoc(1)](https://pandoc.org) to automatically convert markdown to HTML.
|
||||
We currently use [pandoc(1)](https://pandoc.org) to automatically convert markdown to HTML.
|
||||
Please try to avoid submitting an HTML file translation to any markdown file.
|
||||
If you **MUST** submit such an HTML translation, **PLEASE** mention this in your `remarks.md` file.
|
||||
</p>
|
||||
|
||||
<p class="leftbar">
|
||||
For any submission that wins the contest, we modify your `remarks.md` file and
|
||||
rename it as `README.md` and then use [pandoc(1)](https://pandoc.org) to generate
|
||||
rename it as `README.md` and then use [pandoc(1)](https://pandoc.org) to generate
|
||||
the `index.html` file in the top level directory of your submission.
|
||||
For this reason, please do **NOT** submit a `README.md` file, **NOR** an `index.html`
|
||||
file in the top level directory where your `remarks.md` file resides.
|
||||
|
||||
Reference in new issue
Block a user