Add important note about mkiocccentry execution #89
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The next/remarks.example.md filename is kind of a misnomer but it was named this way to match Makefile.example. It has brief instructions along with a link to the FAQ about what one should put in their remarks.md file (and the FAQ links to the new file as a starting point as it has instructions). The markdown guidelines were updated to note that if one does use sections in remarks.md file they should start out at heading level 3 (###) and for each subsection increment it by one (up to level 6).
The FAQ and guidelines need to be improved in this regard but the quick start guide is now consistent with the syntax found in mkiocccentry (which is noted in the FAQ).
Since only try.sh and try.alt.sh files may be executable in submission tarballs, the Makefile.example now notes this and shows how one can adjust this if they need to. This is also in the guidelines, rules and FAQ but those cannot be committed yet.
Rule 17 mandates specific file permissions for files/directories in submission tarballs but the documentation did not state this. More work might need to be done here but it should be better now.
It is highly recommended that you run the tool from either the repo directory itself (making sure you have the most up to date version of course) or make sure you have installed it (also making sure you have the most recent version). Not doing this will cause issues with checks and in the case of out of date versions the submission would be rejected due to violating rule 17. One can specify the options to mkiocccentry for the tools required but if you forget or don't have the most up to date version you will very likely run into problems.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
It is highly recommended that you run the tool from either the repo directory itself (making sure you have the most up to date version of course) or make sure you have installed it (also making sure you have the most recent version). Not doing this will cause issues with checks and in the case of out of date versions the submission would be rejected due to violating rule 17. One can specify the options to mkiocccentry for the tools required but if you forget or don't have the most up to date version you will very likely run into problems.