fix use of temp-test-ioccc
Regarding use of `temp-test-ioccc` in current repo files: We will ignore files under `tmp/` as they are going away. We will ignore files under `bin/` as they will have their default `REPO_URL` value changed during the later parts of the **Great Fork Merge**. We will ignore `*.html` files as the above changes to `bin/` tool will also change them during the later parts of the **Great Fork Merge**. We will ignore `sitemap.xml` as the it will change during the later parts of the **Great Fork Merge**. So this leaves for our consideration the files printed by this command: ```sh find * -type f ! -name '*.html' ! -name sitemap.xml ! -path 'tmp/*' ! -path 'bin/*' -print0 | xargs -0 grep -l 'temp-test-ioccc' ``` We see 5 (3 sir), 3 cases: * README.md index.md The reference to `temp-test-ioccc` will be removed when a given section goes away as part of the later parts of the **Great Fork Merge**. Nothing needs to be dome here other than to add some **XXX** comments to help remind us of what needs to be done in later parts of the **Great Fork Merge**. * bugs.md faq.md news.md var.mk The use of `temp-test-ioccc` is outside of a blob. Here `https://github.com/ioccc-src/temp-test-ioccc/` may be be replaced by `https://github.com/ioccc-src/winner/` in anticipation of the **Great Fork Merge**. There is an exception: The historic discussion abouts the history of the `temp-test-ioccc` repo needs to retain their `https://github.com/ioccc-src/temp-test-ioccc/` strings in `faq.md` and `news.md`. * 2005/sykes/README.md The markdown links that start with `https://github.com/ioccc-src/temp-test-ioccc/blob/master/` should instead start with `%%REPO_URL%%/`. After the **Great Fork Merge**, the `%%REPO_URL%%/` value will refer to `https://github.com/ioccc-src/winner/blob/master/` instead. * 2020/ferguson1/snake.1 There is not a tool to "pre-process" cat pages like there is for markdown files: no should there be. The cat page refers to a markdown file when instead it should refer to a HTML page. In this case we suggest that `https://github.com/ioccc-src/temp-test-ioccc/blob/` be replaced by `https://www.isthe.com/`, and `.md` be replaced by `.html` in anticipation of what it will need to be after the **Great Fork Merge**. * YYYY/entry_dir/*.sh The shell scripts references by the above command are "helper shell scripts. Like man pages, there is no "pre-processor" for shell scripts, nor should there be. Looking at these helper shell script files in detail: ```sh find * -name '*.sh' ! -path 'tmp/*' ! -path 'bin/*' -print0 | xargs -0 grep 'temp-test-ioccc/blob/master' ``` We see that they all make references to `faq.md#something.`. This is wrong in 2 ways: 0) They should not refer to the markdown file `faq.md` but rather to the HTML file `faq.html`. 1) They punctuate a literal string (with one exception) by adding a final period (".") to a string that requires somebody to copy and paste and exclude the final period ("."). Since these echo commands are suggesting that the user view something within the FAQ, we recommend that `echo "Tip: see https://github.com/ioccc-src/temp-test-ioccc/blob/master/faq.md#` be replaced by `echo "Tip: see https://www.ioccc.org/faq.html#` AND that the final period (".") be removed. Thus they too will anticipate what they will need to be after the **Great Fork Merge**.
This commit is contained in:
1 parent
7b0bd24f8e
commit
a78d78ccff
20 files changed
+79
-74
No files matched your search
@@ -382,7 +382,7 @@
|
||||
<!-- START: this line starts content for HTML phase 21 by: bin/pandoc-wrapper.sh via bin/md2html.sh -->
|
||||
|
||||
<!-- BEFORE: 1st line of markdown file: faq.md -->
|
||||
<h1 id="faq-table-of-contents">FAQ Table of Contents <!-- XXX - Change the references from _temp-test-ioccc_ to _winners_ when these fixes are merged. --></h1>
|
||||
<h1 id="faq-table-of-contents">FAQ Table of Contents</h1>
|
||||
<h2 id="section-0---submitting-entries-to-a-new-ioccc">Section 0 - <a href="#faq0">Submitting entries to a new IOCCC</a></h2>
|
||||
<ul>
|
||||
<li><a href="#faq0_0">0.0 - How may I submit to the IOCCC?</a></li>
|
||||
@@ -708,10 +708,10 @@ rules</a>, <a href="next/guidelines.html">IOCCC guidelines</a>
|
||||
and on the <a href="https://github.com/ioccc-src/mkiocccentry">IOCCC mkiocccentry tools</a>.</p>
|
||||
<p>To comment on the <a href="next/rules.html">IOCCC rules</a> or the
|
||||
<a href="next/guidelines.html">IOCCC guidelines</a> please view the
|
||||
<a href="https://github.com/ioccc-src/temp-test-ioccc/discussions">GitHub discussions for this repo</a>.
|
||||
<a href="https://github.com/ioccc-src/winner/discussions">GitHub discussions for this repo</a>.
|
||||
If there is an on-going discussion that seems relevant to what you
|
||||
have to say, consider adding comments to that particular discussion.
|
||||
Otherwise consider opening a <a href="https://github.com/ioccc-src/temp-test-ioccc/discussions/new/choose">new IOCCC repo
|
||||
Otherwise consider opening a <a href="https://github.com/ioccc-src/winner/discussions/new/choose">new IOCCC repo
|
||||
discussion</a>.</p>
|
||||
<p>To comment on <a href="https://github.com/ioccc-src/mkiocccentry">IOCCC mkiocccentry tools</a>,
|
||||
please view the <a href="https://github.com/ioccc-src/mkiocccentry/discussions">mkiocccentry repo discussions</a>.
|
||||
@@ -946,7 +946,7 @@ files) that is more consistent across IOCCC years.</li>
|
||||
<li>Generating HTML content from markdown files and JSON data files via a <a href="bin/index.html">set of
|
||||
tools and scripts</a>.</li>
|
||||
<li>Setting up a system whereby authors of IOCCC entries may update their own
|
||||
contact information via a <a href="https://github.com/ioccc-src/temp-test-ioccc/pulls">GitHub pull
|
||||
contact information via a <a href="https://github.com/ioccc-src/winner/pulls">GitHub pull
|
||||
request</a>.</li>
|
||||
<li>Setting up to generate the top level <a href="years.html">years.html</a> file via the
|
||||
<a href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/bin/gen-years.sh">gen-years.sh</a> tool.</li>
|
||||
@@ -1656,7 +1656,7 @@ known and we are looking for someone to attempt to fix it.</p>
|
||||
that you may wish to try.</p>
|
||||
<p>It also possible that you may have discovered a bug in an winning IOCCC
|
||||
entry. If so, you are invited to try an fix the IOCCC entry and
|
||||
submit that fix by way of a <a href="https://github.com/ioccc-src/temp-test-ioccc/pulls">GitHub pull
|
||||
submit that fix by way of a <a href="https://github.com/ioccc-src/winner/pulls">GitHub pull
|
||||
request</a>.
|
||||
Please see <a href="#fix_an_entry">FAQ 5.2</a> for how to submit a fix to an IOCCC entry.</p>
|
||||
<div id="faq3_14">
|
||||
@@ -2045,7 +2045,7 @@ section may offer you important fixing clues.</p>
|
||||
</div>
|
||||
</div>
|
||||
<p>We do not ‘maintain’ the contest entries as such. The code is made available on an ‘AS
|
||||
IS’ basis. If you have a FIX for an entry, we suggest that you submit your fixes in a <a href="https://github.com/ioccc-src/temp-test-ioccc/pulls">GitHub pull
|
||||
IS’ basis. If you have a FIX for an entry, we suggest that you submit your fixes in a <a href="https://github.com/ioccc-src/winner/pulls">GitHub pull
|
||||
request</a> as we welcome pull requests that have a
|
||||
minimal impact on the entry while improving the portability, functionality, and/or addressing known problems.</p>
|
||||
<p>If you do submit a pull request, we ask that each pull request address just one IOCCC entry at a time.</p>
|
||||
@@ -2728,8 +2728,8 @@ have to be logged into your account.</p>
|
||||
<ul>
|
||||
<li><a href="#creating-a-github-account">Creating a GitHub account</a></li>
|
||||
<li><a href="#installing-an-ssh-key">Installing an ssh key to GitHub</a></li>
|
||||
<li><a href="#forking-the-temp-test-ioccc-repo">Forking the temp-test-ioccc repo</a></li>
|
||||
<li><a href="#cloning-the-temp-test-ioccc-repo">Cloning the temp-test-ioccc repo</a></li>
|
||||
<li><a href="#forking-the-ioccc-winner-repo">Forking the IOCCC winner repo</a></li>
|
||||
<li><a href="#cloning-the-ioccc-winner-repo">Cloning the IOCCC winner repo</a></li>
|
||||
<li><a href="#making-changes-fixes-etc">Making changes, fixes etc.</a></li>
|
||||
<li><a href="#committing-your-changes">Committing your changes</a></li>
|
||||
<li><a href="#opening-a-pull-request">Opening a pull request</a></li>
|
||||
@@ -2760,18 +2760,18 @@ GitHub, it could be anything you wish, as long as it’s in <code>~/.ssh</code>.
|
||||
it might be <code>~/.ssh/github.pub</code>.</p>
|
||||
<p>Whatever the key file is, copy the contents and paste it into the GitHub field
|
||||
labelled <em>Key</em>. Once you have done so click on <em>Add SSH key</em>.</p>
|
||||
<h4 id="forking-the-temp-test-ioccc-repo">Forking the temp-test-ioccc repo</h4>
|
||||
<h4 id="forking-the-ioccc-winner-repo">Forking the IOCCC winner repo</h4>
|
||||
<p>Open in your browser the link:
|
||||
<a href="https://github.com/ioccc-src/temp-test-ioccc/fork" class="uri">https://github.com/ioccc-src/temp-test-ioccc/fork</a>. You now should follow the
|
||||
<a href="https://github.com/ioccc-src/winner/fork" class="uri">https://github.com/ioccc-src/winner/fork</a>. You now should follow the
|
||||
instructions in forking the repo.</p>
|
||||
<h4 id="cloning-the-temp-test-ioccc-repo">Cloning the temp-test-ioccc repo</h4>
|
||||
<h4 id="cloning-the-ioccc-winner-repo">Cloning the IOCCC winner repo</h4>
|
||||
<p>Once you have forked the repo you are ready to clone it to your system. For
|
||||
instance Cody Boone Ferguson has the GitHub handle <em>xexyl</em> so he would type in:</p>
|
||||
<pre><code> git clone https://github.com/xexyl/temp-test-ioccc [target_dir]</code></pre>
|
||||
<pre><code> git clone https://github.com/xexyl/winner [target_dir]</code></pre>
|
||||
<p>Once that is completed you will need to change to that directory. The default
|
||||
directory would be the name of the repo but if you specified a target directory
|
||||
it will be that. For instance using the above example you might do:</p>
|
||||
<pre><code> cd temp-test-ioccc</code></pre>
|
||||
<pre><code> cd winner</code></pre>
|
||||
<p>You’re ready to make your changes now!</p>
|
||||
<h4 id="making-changes-fixes-etc.">Making changes, fixes etc.</h4>
|
||||
<p>Here you must use your wits, knowledge, creativity and whatever else you have.
|
||||
@@ -2803,8 +2803,8 @@ with your ssh key. To do this you need to do:</p>
|
||||
<p>Hi xexyl! You’ve successfully authenticated, but GitHub does not provide shell access.</p>
|
||||
</blockquote>
|
||||
<p>Now, assuming that the forked repo is
|
||||
<a href="https://github.com/xexyl/temp-test-ioccc" class="uri">https://github.com/xexyl/temp-test-ioccc</a>, you’d type:</p>
|
||||
<pre><code> git remote set-url origin git@github.com:xexyl/temp-test-ioccc.git</code></pre>
|
||||
<a href="https://github.com/xexyl/winner" class="uri">https://github.com/xexyl/winner</a>, you’d type:</p>
|
||||
<pre><code> git remote set-url origin git@github.com:xexyl/winner.git</code></pre>
|
||||
<p>Now you’d be ready to make your commits.</p>
|
||||
<p>Before doing anything else, however, a new branch needs to be created.
|
||||
Continuing the example above for
|
||||
@@ -2840,16 +2840,16 @@ warrant the log:</p>
|
||||
remote: Resolving deltas: 100% (4/4), completed with 4 local objects.
|
||||
remote:
|
||||
remote: Create a pull request for 'human-snakes' on GitHub by visiting:
|
||||
remote: https://github.com/xexyl/temp-test-ioccc/pull/new/human-snakes
|
||||
remote: https://github.com/xexyl/winner/pull/new/human-snakes
|
||||
remote:
|
||||
To github.com:xexyl/temp-test-ioccc.git
|
||||
To github.com:xexyl/winner.git
|
||||
* [new branch] human-snakes -> human-snakes
|
||||
branch 'human-snakes' set up to track 'origin/human-snakes'.</code></pre>
|
||||
<p>The link referred to above would then be opened to open a pull request. Just
|
||||
follow the instructions at this point. If however it does not show a link it is
|
||||
likely because the branch already exists in your GitHub account (for the repo).
|
||||
In this case you can open the link:
|
||||
<a href="https://github.com/ioccc-src/temp-test-ioccc/pulls" class="uri">https://github.com/ioccc-src/temp-test-ioccc/pulls</a> which might show something
|
||||
<a href="https://github.com/ioccc-src/winner/pulls" class="uri">https://github.com/ioccc-src/winner/pulls</a> which might show something
|
||||
like:</p>
|
||||
<pre><code> xexyl:human-snakes had recent pushes 1 minute ago</code></pre>
|
||||
<p>and to the right of it you would see a button that says <em>Compare & pull request</em>
|
||||
@@ -2875,7 +2875,7 @@ in the matter.</p>
|
||||
<p>When the judges have merged the pull request you now need to make sure your fork
|
||||
has the merge. To do this from the command line, assuming the fork in the above
|
||||
example, you would type:</p>
|
||||
<pre><code> git checkout master && git pull https://github.com/ioccc-src/temp-test-ioccc.git master && git push origin master</code></pre>
|
||||
<pre><code> git checkout master && git pull https://github.com/ioccc-src/winner.git master && git push origin master</code></pre>
|
||||
<p>This will merge your pull request to your fork.</p>
|
||||
<div id="faq6_11">
|
||||
<div id="license">
|
||||
|
||||
Reference in new issue
Block a user