fivem-docs icon indicating copy to clipboard operation
fivem-docs copied to clipboard

feat(doc/coding): new guideline

Open PsychoShock opened this issue 1 year ago • 2 comments

Should handle the basics on coding guidelines.

PsychoShock avatar Jul 12 '24 01:07 PsychoShock

Aditionally, I'm a bit confused about what you mean by 'coding guidelines' here. Generally, coding guidelines are standards to ensure code is concise and to facilitate easier collaboration among team members, given that everyone might have different coding styles.

Should I just change the structure to method signature then and move this to scripting-ref (https://github.com/citizenfx/fivem-docs/pull/463)?

PsychoShock avatar Jul 16 '24 02:07 PsychoShock

Aditionally, I'm a bit confused about what you mean by 'coding guidelines' here. Generally, coding guidelines are standards to ensure code is concise and to facilitate easier collaboration among team members, given that everyone might have different coding styles.

Should I just change the structure to method signature then

I'm not sure what you mean by 'method signature' in this context.

move this to scripting-ref (#463)?

I think the main idea is that the title of this is wrong. It looks more like a 'Getting Started with FiveM Development' guide. I would focus on improving the current pages instead of changing the structure of the documentation, since it might be structured that way for a reason. Just a suggestion! 😊

colistro123 avatar Jul 16 '24 02:07 colistro123

None of this seems to be related to coding guidelines, this should go over best practices for resources, like secure your events, check the data sent from the client, etc.

AvarianKnight avatar Aug 07 '24 20:08 AvarianKnight