6502/cc65
1
0
Fork 0
mirror of https://github.com/cc65/cc65.git synced 2025-03-03 09:32:33 +00:00
Code Issues Projects Releases Wiki Activity

Update Contributing.md

Browse Source
This commit is contained in:
Bob Andrews 2023-05-04 09:18:33 +02:00 committed by GitHub
parent b743b1a8c2
commit 13f317e660
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Contributing.md
View File

@ -74,10 +74,12 @@ color := $0787
The following is still very incomplete - if in doubt please look at existing sourcefiles and adapt to the existing style The following is still very incomplete - if in doubt please look at existing sourcefiles and adapt to the existing style
* Your files should obey the C89 standard. * Your files should generally obey the C89 standard, with a few C99 things (this is a bit similar to what cc65 itself supports). The exceptions are:
* use stdint.h for variables that require a certain bit size
* In printf-style functions use the PRIX64 (and similar) macros to deal with 64bit values (from inttypes.h)
This list is not necessarily complete - if in doubt, please ask.
* We generally have a "no warnings" policy * We generally have a "no warnings" policy
* Warnings must not be hidden by using typecasts - fix the code instead * Warnings must not be hidden by using typecasts - fix the code instead
* In printf-style functions use the PRIX64 (and similar) macros to deal with 64bit values
* The normal indentation width should be four spaces. * The normal indentation width should be four spaces.
* You must use ANSI C comments (```/* */```); you must not use C++ comments (```//```). * You must use ANSI C comments (```/* */```); you must not use C++ comments (```//```).
* When you add functions to an existing file, you should separate them by the same number of blank lines that separate the functions that already are in that file. * When you add functions to an existing file, you should separate them by the same number of blank lines that separate the functions that already are in that file.