Skip to content
Snippets Groups Projects
Commit 5f720ea4 authored by Rob Swindell's avatar Rob Swindell :speech_balloon:
Browse files

Commit message etiquette.

Safe-string handling in C/C++.
parent 9d78353e
No related branches found
No related tags found
1 merge request!463MRC mods by Codefenix (2024-10-20)
...@@ -9,11 +9,18 @@ When submitting merge requests to existing files, unless you have prior agreemen ...@@ -9,11 +9,18 @@ When submitting merge requests to existing files, unless you have prior agreemen
* Do not include changes that are not relevant to the merge request description/message * Do not include changes that are not relevant to the merge request description/message
* Keep merge requests to a single topical change (e.g. don't combine new features with bug fixes with typo-fixes and style changes) * Keep merge requests to a single topical change (e.g. don't combine new features with bug fixes with typo-fixes and style changes)
### Commit content
In general, if it's a large set of changes, your best bet of getting it accepted and merged into the repo would be to discuss the concept of the change with the developers in the [Synchronet Programming conference](http://web.synchro.net/?page=001-forum.ssjs&sub=syncprog) **first**. In general, if it's a large set of changes, your best bet of getting it accepted and merged into the repo would be to discuss the concept of the change with the developers in the [Synchronet Programming conference](http://web.synchro.net/?page=001-forum.ssjs&sub=syncprog) **first**.
When modifying the C/C++ source files: When modifying the C/C++ source files:
* Do not call functions from `ctype.h` (e.g. `isprint`, `isspace`, `isdigit`, etc.) - use the `gen_defs.h IS_*` macros instead. * Do not call functions from `ctype.h` (e.g. `isprint()`, `isspace()`, `isdigit()`, etc.) - use the `gen_defs.h IS_*` macros instead.
* Use safe string handling (e.g. `SAFECOPY()` instead of `strcpy()`, `SAFEPRINTF()` or `safe_snprintf()` instead of `sprintf()`).
### Commit messages
* Try to keep the commit title (first line) to 70 characters or less.
* When a comment is related to an [issue](https://gitlab.synchro.net/main/sbbs/-/issues), use the proper commit message syntax foir automatic issue management as documented [here](https://docs.gitlab.com/ce/user/project/issues/managing_issues.html#closing-issues-automatically).
### Other types of contributions
If you were interested in contributing money, not code, then paypal to rob at synchro dot net. If you were interested in contributing money, not code, then paypal to rob at synchro dot net.
Thank you for contributing! Thank you for contributing!
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment