Project conventions document

Document detailing project conventions and how to use Perforce

Documentation for "Below Their Sight", a project currently in development using Unreal Engine 5. The team of eleven members including myself, contains one other programmer, a project manager, three graphic artists, two game designers, a UR/UX specialist, a UI specialist and a sound designer. This document was created collaboration with another programmer and details the various conventions that the members must respect throughout production. Containing rules on asset names, project directory organisation, coding norms, commit norms and a detailed tutorial on the use of Perforce and P4V (the versioning software for the project).

What I worked on

Perforce/P4V:

• Detailed instructions on setting up a workspace and the p4Ignore
• Detailed instructions on how to use P4V. Information on how to, Reconcile/Add your work, Submit, Get Latest, handling of changelists, the use of checkouts... 
• Troubleshooting instructions. Recognising and resolving conflicts. As well as solving common problems.
• Correct practices when working with a versioning software. Regularity of commits, when to get latest...

Project Conventions:

• Collaborated for the conception of the project directory hierarchy, coding norms and asset naming.

This documentation is written in french, as the team is predominantly french and to avoid any miscomprehension .