Skip to content

Commit c107178

Browse files
authored
Initial Contributing.md
1 parent 833386c commit c107178

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

Contributing.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,3 +22,25 @@ Every _group_ sub-directory contains at least one _Comment Section_ file. These
2222
Most _groups_ _(like [Interrupt List](source/Interrupt%20List) and [Ports List](source/Ports%20List))_ can contain numerious sub-directories and files used for the items in a _LST_ file. The directory and file names for those items is 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 maintaning the project.
2323

2424
_Note: All files are required to have a `.txt` file extention and must be encoded in standard ASCII using code page 437. UTF-8 and other text encoding schemes are not supported at this time._
25+
26+
## List item entries
27+
28+
The individual list item entry files each contain a header that has important information that is needed when compiling the list files. The header starts end ends with two vertical bars comprised of 80 dashes (minus characters). While there are several possible fields, only the **Unique ID** field is absolutely mandatory.
29+
30+
* **Unique ID** - Manditory field. It contains the ID which will be used for the section break in the compiled _LST_ file. For example, _Interrupt 21h function 4Ch_ has a _Unique ID_ of `214C`.
31+
32+
However, sometimes there is insufficient uniqueness for an ID to distinguish it from another entry. For such items,
33+
the ID can be suffixed with a **sort-as** to better identify the entry and guarantee the order in a _LST_ file.
34+
35+
For example, there are be multiple entries for _Interrupt 21h function 40h_. These entries have _Unique IDs_ like `2140-sort-as-2140++` and `2140-sort-as-2140PC/TCP` to always maintain their the same order in _The List_. Additional text after the _Unique ID_ is prohibited.
36+
37+
* **Sort As** - Optional field. This is an alternative method to the _sort-as_ suffix for providing additional uniqueness. Using one of the previously mentioned entries as an example, you could enter `Unique ID: 2140` and `Sort as: 2140PC/TCP`. Additional text after the _Sorting ID_ is prohibited.
38+
39+
Either method of providing a _Sorting ID_ is equally acceptable. However, do not use both the `-sort-as-` suffix and the `Sort As` field in the same entry.
40+
41+
* **Category** - Recommended field. This is a single character field as listed in the [_Categories.txt](source/Interrupt%20List/_Categories.txt) file or `n/a`. While not required, additional text is recommended after the _category identifier_ in order to ease identification of the category. Entries are restricted to only a single _category_ per file.
42+
43+
* **Flag** - Recommended field. Like the _Category_ field, this is a single character field as listed in the [_Flags.txt](source/Interrupt%20List/_Flags.txt) file or `n/a`. While not required, additional text is recommended after the _flag identifier_ in order to ease identification of the flag. You may include several _Flag_ fields in the header if needed.
44+
45+
### _(tbd)_
46+

0 commit comments

Comments
 (0)