From 1e1b26f32055f95b613372cbf91319c08ef8d950 Mon Sep 17 00:00:00 2001 From: Landon Curt Noll Date: Thu, 30 Nov 2023 23:31:26 -0800 Subject: [PATCH] update FAQ Completed information for FAQ 5.5. Removed a few redundant words in the FAQ.. --- faq.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/faq.md b/faq.md index 40e1e9f65..4e14e8c2b 100644 --- a/faq.md +++ b/faq.md @@ -1384,14 +1384,14 @@ 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. +repo](https://github.com/ioccc-src/winner). 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. +[ioccc-src/winner repo](https://github.com/ioccc-src/winner). NOTE: some of the issues in the [bugs.md](/bugs.md) file includes just missing files and we welcome these too! @@ -1406,7 +1406,7 @@ 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. +of the [ioccc-src/winner repo](https://github.com/ioccc-src/winner). Note that we're much more inclined to accept an author's fixes but the judges have the final say in the matter. @@ -1441,7 +1441,7 @@ see [FAQ 5.2](#faq5_2) for information on how submit a fix to an IOCCC winner. You may open 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 +of the [ioccc-src/winner repo](https://github.com/ioccc-src/winner) to submit a fix. #### Some HTML files should NOT be directly modified @@ -1459,7 +1459,7 @@ If you see lines containing: This means that the file is generated by a tool from the [build-ioccc repo](https://github.com/ioccc-src/build-ioccc) using files found in the -[ioccc-src/winner repo](https://github.com/ioccc-src/winner) repo. +[ioccc-src/winner repo](https://github.com/ioccc-src/winner). You will find a HTML comment of the form indicating which tool was used to generate the contents: @@ -1499,7 +1499,10 @@ The contents of these JSON files contain the best known information about authors of IOCCC winners. See [FAQ 6.6](#faq6_6) for information about the contents of these JSON file and how they are used. -XXX +You may update IOCCC author information in a `author_handle.json` file +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). ## Section 6: Miscellaneous IOCCC