Minor improvements to how-to-bug-fix.md

This commit is contained in:
Cody Boone Ferguson committed 2023-07-05 05:06:42 -07:00
1 parent cffdff6ac3
commit e1bb3f7043
1 file changed
+26 -18
+26 -18
View File
@@ -1,31 +1,39 @@
# How to fix an IOCCC entry # How to submit a fix to an IOCCC entry
If you see a problem with an IOCCC entry, first check the If you see a problem with an IOCCC entry, first check the [known bugs](bugs.md)
[known bugs](bugs.md) file. In some cases what you might think file. In some cases what you might think of as a bug is instead a known
of as a bug is instead a known feature. On some cases the feature. In some cases the bug is known, but no fix has ever been submitted.
bug is known, but no fix has ever been submitted. In other In other cases you may have found a new problem.
cases you may have found a new problem.
If you do have a fix, and the [known bugs](bugs.md) file **does If you do have a fix, and the [known bugs](bugs.md) file **does not recommend
not recommend against fixing it**, then please opening a [GitHub pull against fixing it**, then please consider opening a [GitHub pull
request](https://github.com/ioccc-src/winner/pulls) against the master request](https://github.com/ioccc-src/winner/pulls) against the master
[branch](https://github.com/ioccc-src/winner/branches) of the [ioccc-src/winner [branch](https://github.com/ioccc-src/winner/branches) of the [ioccc-src/winner
repo](https://github.com/ioccc-src/winner) repo. repo](https://github.com/ioccc-src/winner) repo.
BTW: A **problem** is not limited to the code itself. Fixing typos in files such BTW: A **problem** is not limited to the code itself. Fixing typos in files
as "_README.md_" files, fixing issues in a "_Makefile_", or otherwise correcting an such as "_README.md_" files, fixing issues in a "_Makefile_", or otherwise
IOCCC winner is **VERY MUCH WELCOME**! Please use the same [GitHub pull correcting an IOCCC winner is **VERY MUCH WELCOME**! Please use the same
request](https://github.com/ioccc-src/winner/pulls) process against the master [GitHub pull request](https://github.com/ioccc-src/winner/pulls) process against
[branch](https://github.com/ioccc-src/winner/branches) of the [ioccc-src/winner the master [branch](https://github.com/ioccc-src/winner/branches) of the
repo](https://github.com/ioccc-src/winner) repo. [ioccc-src/winner repo](https://github.com/ioccc-src/winner) repo.
**Please help us fix typos and / or otherwise improve the write-up** of NOTE: some of the issues in the [bugs.md](/bugs.md) file includes just missing
how IOCCC winning entries are presented! files and we welcome these too!
And of course, an IOCCC winner's may update their own entries **Please also help us fix typos and / or otherwise improve the write-up** of how
IOCCC winning entries are presented!
In any event we will happily add you to the
[thanks-for-fixes.md](/thanks-for-fixes.md) file for your help!
And of course, an IOCCC winner may update their own entries
(metadata as well as source code and any extra files) by opening a (metadata as well as source code and any extra files) by opening a
[GitHub pull request](https://github.com/ioccc-src/winner/pulls) [GitHub pull request](https://github.com/ioccc-src/winner/pulls)
against the master [branch](https://github.com/ioccc-src/winner/branches) against the master [branch](https://github.com/ioccc-src/winner/branches)
of the [ioccc-src/winner repo](https://github.com/ioccc-src/winner) of the [ioccc-src/winner repo](https://github.com/ioccc-src/winner)
repo. repo.
e
Note that we're much more inclined to accept an author's fixes but the judges
have the final say in the matter.