search

citizenfx / fivem-docs

FiveM documentation repository
https://docs.fivem.net/
101 stars 300 forks source link

feat(doc/coding): new guideline #461

Closed PsychoShock closed 3 months ago

PsychoShock commented 4 months ago

Should handle the basics on coding guidelines.

PsychoShock commented 3 months ago

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)?

colistro123 commented 3 months ago

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! 😊

AvarianKnight commented 3 months ago

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.