Introduction

Establishing a set of style guidelines is essential for maintaining a consistent and professional appearance in all our projects at RFG Studio's. This document outlines the general style guidelines that all developers should follow.

Code Style

1. Indentation:

2. Use 4 spaces for indentation. Avoid using tabs to ensure consistency across different editors.

3. Naming Conventions:

4. Use CamelCase for class names (e.g., PlayerController).

5. Use snake case for variable and function names (e.g., player health, spawn_enemy).

6. Comments:

7. Use single-line comments (-- Comment here) for brief explanations.
8. Use block comments (--[[ Comment here ]]) for more extensive documentation.

File Organization

1. Folder Structure:
2. Organize files into logical folders based on functionality (e.g., /src, /assets, /scripts).

3. Use clear, descriptive names for folders and files.

4. File Naming:

5. Use lowercase letters for file names and do not use underscores for separation, please do space only (e.g., player health.lua).
6. Avoid spaces and special characters in file names.

UI Design

1. Consistency:
2. Maintain a uniform design language across all UI elements.

3. Use a defined color palette and typography throughout the project.

4. Alignment:

5. Ensure elements are properly aligned to create a clean layout.
6. Use grids and guides to maintain structure.

Documentation

1. Readability:
2. Write documentation that is clear and concise.

3. Use headings, bullet points, and numbered lists to improve readability.

4. Version Control:

5. Document changes made in the codebase with clear commit messages.
6. Maintain a changelog for significant updates and modifications.

Best Practices

1. Code Reviews:
2. Participate in regular code reviews to maintain code quality and consistency.
3. Provide constructive feedback and be open to receiving it.

4. Send code review in discord.

5. Version Control:

6. Use Asana for version control.

Conclusion

By following these general style guidelines, we can ensure that our projects at RFG Studio's are well-organized, maintainable, and professional. Consistency in style enhances collaboration and improves the overall quality of our work. If you have any questions or suggestions for these guidelines, please reach out.