Skip to content

Contributing.md: drop MORE, typo, mention order from IDs, filenames #75

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
shidel merged 1 commit into from
Apr 17, 2026
+2 −3
Merged

Contributing.md: drop MORE, typo, mention order from IDs, filenames #75

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions Contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ With the exception of the [Miscellaneous](source/Miscellaneous) directory, the o

## Group sub-directories

Every _group_ sub-directory contains at least one _Comment Section_ file. These files always start with an **underscore** character. Generally, these files are included as-is into the appropriate _LST_ file based on the order as defined in the [_Mapping.txt](source/_Mapping.txt) file.
Every _group_ sub-directory contains at least one _Comment Section_ file. The filenames of these files always start with an **underscore** character. Generally, these files are included as-is into the appropriate _LST_ file based on the order as defined in the [_Mapping.txt](source/_Mapping.txt) file.

Most _groups_ _(like [Interrupt List](source/Interrupt%20List) and [Ports List](source/Ports%20List))_ can contain numerous sub-directories and files used for the items in a _LST_ file. The directory and file names for those items are not important to the program that compiles _The List_. Their names are only for our convience when finding and editing an entry for _The List_. Those items can be broken down into any level of sub-paths which we find suitable to our needs in maintaining the project.
Most _groups_ _(like [Interrupt List](source/Interrupt%20List) and [Ports List](source/Ports%20List))_ can contain numerous sub-directories and files used for the items in a _LST_ file. The directory and file names for those items are not important to the program that compiles _The List_. Their names are only for our convenience when finding and editing an entry for _The List_. Those items can be broken down into any level of sub-paths which we find suitable to our needs in maintaining the project. (When compiling, the unique IDs or sort-as IDs (described below) are used to determine the order of entries.)

_Note: All files are required to have a `.txt` filename extension and must be encoded in standard ASCII using code page 437. UTF-8 and other text encoding schemes are not supported at this time._

Expand Down Expand Up @@ -117,7 +117,6 @@ The section names are:
* Desc:
* Note:
* Notes:
* MORE:
* BUG:
* BUGS:
* Program:
Expand Down