From e1bb3f704359f9148b38ee6bb031e6d9e5268f07 Mon Sep 17 00:00:00 2001 From: Cody Boone Ferguson <53008573+xexyl@users.noreply.github.com> Date: Wed, 5 Jul 2023 05:06:42 -0700 Subject: [PATCH] Minor improvements to how-to-bug-fix.md --- how-to-bugfix.md | 44 ++++++++++++++++++++++++++------------------ 1 file changed, 26 insertions(+), 18 deletions(-) diff --git a/how-to-bugfix.md b/how-to-bugfix.md index bb2b5687f..acaa96877 100644 --- a/how-to-bugfix.md +++ b/how-to-bugfix.md @@ -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 -[known bugs](bugs.md) file. In some cases what you might think -of as a bug is instead a known feature. On some cases the -bug is known, but no fix has ever been submitted. In other -cases you may have found a new problem. +If you see a problem with an IOCCC entry, first check the [known bugs](bugs.md) +file. In some cases what you might think of as a bug is instead a known +feature. In some cases the bug is known, but no fix has ever been submitted. +In other cases you may have found a new problem. -If you do have a fix, and the [known bugs](bugs.md) file **does -not recommend against fixing it**, then please opening a [GitHub pull +If you do have a fix, and the [known bugs](bugs.md) file **does not recommend +against fixing it**, then please consider opening a [GitHub pull request](https://github.com/ioccc-src/winner/pulls) against the master [branch](https://github.com/ioccc-src/winner/branches) of the [ioccc-src/winner repo](https://github.com/ioccc-src/winner) repo. -BTW: A **problem** is not limited to the code itself. Fixing typos in files such -as "_README.md_" files, fixing issues in a "_Makefile_", or otherwise correcting an -IOCCC winner is **VERY MUCH WELCOME**! Please use the same [GitHub pull -request](https://github.com/ioccc-src/winner/pulls) process against the master -[branch](https://github.com/ioccc-src/winner/branches) of the [ioccc-src/winner -repo](https://github.com/ioccc-src/winner) repo. +BTW: A **problem** is not limited to the code itself. Fixing typos in files +such as "_README.md_" files, fixing issues in a "_Makefile_", or otherwise +correcting an IOCCC winner is **VERY MUCH WELCOME**! Please use the same +[GitHub pull request](https://github.com/ioccc-src/winner/pulls) process against +the master [branch](https://github.com/ioccc-src/winner/branches) of the +[ioccc-src/winner repo](https://github.com/ioccc-src/winner) repo. -**Please help us fix typos and / or otherwise improve the write-up** of -how IOCCC winning entries are presented! +NOTE: some of the issues in the [bugs.md](/bugs.md) file includes just missing +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 [GitHub pull request](https://github.com/ioccc-src/winner/pulls) against the master [branch](https://github.com/ioccc-src/winner/branches) of the [ioccc-src/winner repo](https://github.com/ioccc-src/winner) 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. +