ioccc-src / temp-test-ioccc

Temporary test IOCCC web site that will go away
Creative Commons Attribution Share Alike 4.0 International
48 stars 7 forks source link

Enhancement: Fix typos #2

Closed lcn2 closed 11 months ago

lcn2 commented 1 year ago

Scope - About this issue

Fix typos in "judges remarks / winner writeup / winner's remarks".

Fix typos in Makefiles.

Fix typos in rules and guidelines for a given year.

Typos include spelling and grammar.

NOTE: This writeup is subject to changes and revisions as the understanding of this issue evolves / improves. Check back to this note from time to time. When modification are made to this comment, we will try to add a note indicating that the scope of this issue has been updated.

Rules and guidelines

To preserve the rules, when a typo is fixed in a rules file, the original rules should be copied into orig.rules. This helps preserve the historic record.

To preserve the guidelines, when a typo is fixed in a guidelines file, the original rules should be copied into orig.guidelines. This helps preserve the historic record.

In some cases rules and guidelines had intentional "bugs". Some of those "bugs" may be in the form of a typo. As such this should NOT be fixed. When in doubt, ask an IOCCC judge.

Language

The spelling and grammar of text written by an IOCCC judge should be in "US English".

The spelling and grammar of winner, however, may differ depending on the origin of the winner.

Edit with some judgment in mind. :-)

Other files

Typos in other webs site files are in scope. Nevertheless, one should NOT edit typos in source code. Such types are "features, not bugs". :-)

lcn2 commented 1 year ago

We believe we have addressed all of the current questions that still need answering at this time. If we've missed something or something else needs to be clarified, please ask again.

lcn2 commented 1 year ago

QUESTION

What is the status of this issue? Are we ready to close it?

xexyl commented 1 year ago

QUESTION

What is the status of this issue? Are we ready to close it?

Sadly not ready. But the good news is when I'm done with the README.md files (as part of #3) we can probably close this one too.

lcn2 commented 12 months ago

We believe we have addressed all of the current questions that still need answering at this time. If we've missed something or something else needs to be clarified, please ask again.

xexyl commented 11 months ago

As far as your query about whether or not the final README files being done (when they are) meaning we can close this issue: most files have had at least one pass and although there might be a few typos left I will discover them with the other issues so if you wanted to close this one (as it is indeed mostly done) that would be quite all right.

If that makes it seem like we're slightly further along then maybe it's even preferable. But in a sense with the exception of the new files like the thanks file and FAQ and such this is mostly done indeed.

I will let you decide whether that's reason enough to close this but I will say that I agree with what I think you think too: it would look nice if another issue was closed AND SINCE the other issue is finishing this one up as well it seems like it would be fine to close anyway.

I am going to try resting now but I should be able to get some entries of 2019 done today. I do have two appointments today (both at home - zoom and phone calls) but only the first one would be at a time that would interrupt my work here. Whether I can do more after that is unknown but it is possible. However that would not be for very long: no more than say an hour and 15 minutes to maybe an hour and 20 or 25 minutes. It's highly unlikely that after that call I will be able to do more.

But for now I'm going to try resting I think. If I can't then I will sit up and try and work on the next entries.

Back in a bit or a while! Again I leave it up to you whether you want to close this issue but on my behalf I think it's more than reasonable! I hope that makes you happy. If I am honest it would kind of make me happy too but less than you probably because I still am not done with all the README files! Still it would also be good as a trick against the mind: it appears that there's one more thing done and since it mostly is done it is fine to close it!

So that's my opinion FWIW.

xexyl commented 11 months ago

To put the above comment more simply: feel free to close this issue. Any remaining I see will be fixed when going through the remaining files. I am aware I missed some but of course that's expected. Most have been addressed though. In some cases I was not sure what something should be so I kept it the same. In cases where I was extra tired I might have missed something too. Plus I am trying to finish it all by the end of the year. Those might be why I missed some but mostly they're all corrected (with the caveat that some of the times I was not aware of what something should be so I kept them the same). Other times of course typos were intentional so those were also kept in.

lcn2 commented 11 months ago

Closing this issue as per comment 1860591483.

In particular, as most files have had at least 1 pass, and as issue #3 will address potential typos in the remaining 2019 and 2020 IOCCC years, we can consider this particular issue completed.

Yes, there will be typos to review such as those in the FAQ, the thank you file, top level markdown files (once they are converted from the existing top level HTML), etc. Those files may be reviewed as needed.

Prior to perform the "great fork merge" with the official winner IOCCC repo, a final pre-merge check will be performed. That check at that time will include a typo review.

The "going live" (via the "great fork merge") the Official IOCCC news will be updated, inviting the public to comment and correct (via pull requests), on there state of this temp-test-ioccc repo, allowing for yet another period (perhaps 2-3 weeks) where typos may be corrected.

Thanks for all the help in fixing typos!

xexyl commented 11 months ago

Closing this issue as per comment 1860591483.

In particular, as most files have had at least 1 pass, and as issue #3 will address potential typos in the remaining 2019 and 2020 IOCCC years, we can consider this particular issue completed.

Glad you agree! It looks nice too to only have two entries that are important for the next phase. The OT one is not important and the template one is not important for it either. Just the JSON one (which requires the other repo unfortunately) and the consistency one which is getting there.

Yes, there will be typos to review such as those in the FAQ, the thank you file, top level markdown files (once they are converted from the existing top level HTML), etc. Those files may be reviewed as needed.

Of course. That's expected.

Prior to perform the "great fork merge" with the official winner IOCCC repo, a final pre-merge check will be performed. That check at that time will include a typo review.

I'll be part of that too to be sure. I have some other things on my mind to be doing too with that.

The "going live" (via the "great fork merge") the Official IOCCC news will be updated, inviting the public to comment and correct (via pull requests), on there state of this temp-test-ioccc repo, allowing for yet another period (perhaps 2-3 weeks) where typos may be corrected.

And you can be sure I'll be part of that too. It's not a bad idea to do what you plan. As you'll notice if you haven't already I discovered some problems today when going through entries to mark them as having to disable the optimiser (the few that have that requirement that I have discovered so far).

Thanks for all the help in fixing typos!

You are most welcome! I'm happy to help and you can be sure I'll be doing more. I have something else unrelated to the IOCCC to do and when I'm done with that I hope to resume 2019.

As for typos 'always being there' that's even more true when one considers that there will be other entries in the future - 2024 and on. The good news is the future contests won't take nearly as much time to go through as it'll be just one at a time and the entries will work in modern systems because they're developed for modern systems!