Skip to content

Commit 303687a

Browse files
committed
docs
1 parent 2e91ce3 commit 303687a

File tree

1 file changed

+26
-1
lines changed

1 file changed

+26
-1
lines changed

CONTRIBUTING.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,32 @@ The numbering at the beginning of the header filenames serves a dual purpose:
8080

8181
* Feature classification (e.g., core types that require memory allocation are in the 100-199 range while new type templates are placed in the 200-299 range). This numbering ensures that modules are added in the correct sequence and can manage their dependencies efficiently.
8282

83-
* Please remember to add your module to both the `include.h` and `000 dependencies.h` header files, so people can access it.
83+
84+
These are the current numbering ranges:
85+
86+
* 000-099: core features, ordered by priority and dependency. This may also include non-core helpers and parsers that require no memory allocation.
87+
88+
* 100-198: non-template / core types and building blocks. This may also include parsers that require memory allocations.
89+
90+
* 200-298: template types – types that can be customized using macros, such as hash maps and dynamic arrays.
91+
92+
* 300-398: cryptography and cryptographic tools - these should be considered as fallback elements when a cryptography library is missing.
93+
94+
* 400-498: server, web and IO, such as HTTP, WebSockets, communication protocols, etc'.
95+
96+
* 500: FIOBJ soft types.
97+
98+
* 501-598: to be decided.
99+
100+
* 600-698: to be decided.
101+
102+
* 700: cleanup.
103+
104+
* 900-998: tests.
105+
106+
Please remember to add your module to both the `include.h` and `000 dependencies.h` header files, so people can access it.
107+
108+
Please write tests to test your module. See the `902 empty module tests.h` boilerplate.
84109

85110
### Community Guideline - Play Nice
86111

0 commit comments

Comments
 (0)