Skip to content

Commit 2e91ce3

Browse files
committed
docs + name changes (breaking API) should bump stuff
1 parent 71efc2d commit 2e91ce3

File tree

3 files changed

+24
-2
lines changed

3 files changed

+24
-2
lines changed

CONTRIBUTING.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ Thank you for inquiring `facil.io`'s contribution guide. It's people like you an
66

77
* Play nice.
88

9+
* Contributions and edits to the code should be placed in the `/fio-stl` folder and its many header files which are numbered by priority and classification (**NOT** in the auto-generated `fio-stl.h` header).
10+
911
* PRs are appreciated. Most likely the code you're looking for is @ the [facil.io C STL repository](https://github.com/facil-io/cstl).
1012

1113
* Always add a comment in the CHANGELOG to say what you did and credit yourself.
@@ -60,6 +62,26 @@ Thank you for inquiring `facil.io`'s contribution guide. It's people like you an
6062

6163
See the License section below. Contributions must relinquish ownership of contributed code, so licensing and copyright can be managed without the need to reach out to every past contributor.
6264

65+
### File Naming and Edits
66+
67+
The `fio-stl.h` header is **Auto-Generated** - do **not** edit it.
68+
69+
Any new features or changes should be made in the individual headers placed in the `./fio-stl` **folder**. This avoids manual edits and ensures consistency during the generation process.
70+
71+
#### Boilerplate for New Modules
72+
73+
There's a template or boilerplate for new modules provided the [`./fio-stl/699 empty module.h`](https://github.com/facil-io/cstl/blob/master/fio-stl/699%20empty%20module.h), which should be used as the starting point for adding any new functionality. This includes the necessary structure and naming conventions for creating new modules within the CSTL.
74+
75+
#### Numbering Scheme for Header Files
76+
77+
The numbering at the beginning of the header filenames serves a dual purpose:
78+
79+
* Prioritization in the generated fio-stl.h file (e.g., headers that require dynamic memory allocation begin from 100).
80+
81+
* 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.
82+
83+
* Please remember to add your module to both the `include.h` and `000 dependencies.h` header files, so people can access it.
84+
6385
### Community Guideline - Play Nice
6486

6587
As a child, I wasn't any good with people (I'm not sure I'm any better now that I'm older)... which is how come I became good with computers and why we have `facil.io` and other open source projects ;-)

fio-stl.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ supports macros that will help detect and validate it's version.
6868
/** PATCH version: Bug fixes, minor features may be added. */
6969
#define FIO_VERSION_PATCH 0
7070
/** Build version: optional build info (string), i.e. "beta.02" */
71-
#define FIO_VERSION_BUILD "alpha.07"
71+
#define FIO_VERSION_BUILD "alpha.08"
7272

7373
#ifdef FIO_VERSION_BUILD
7474
/** Version as a String literal (MACRO). */

fio-stl/000 core.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ supports macros that will help detect and validate it's version.
3131
/** PATCH version: Bug fixes, minor features may be added. */
3232
#define FIO_VERSION_PATCH 0
3333
/** Build version: optional build info (string), i.e. "beta.02" */
34-
#define FIO_VERSION_BUILD "alpha.07"
34+
#define FIO_VERSION_BUILD "alpha.08"
3535

3636
#ifdef FIO_VERSION_BUILD
3737
/** Version as a String literal (MACRO). */

0 commit comments

Comments
 (0)