`docs: Update contributing.md for clarity and environment setup`

[benoit-bremaud]

Description:

Summary

The contributing.md file is outdated and certain sections, particularly the one explaining how to create environment variable files, are unclear. This document needs to be updated to include detailed instructions for different operating systems (Linux, Windows, and macOS) and explicitly explain which options to uncomment in the .env file (which is a copy of the .env.example).

Context

Having clear and up-to-date documentation is crucial for onboarding new contributors and ensuring a smooth development process. The current lack of clarity in the contributing.md file can lead to confusion and setup issues.

Objectives

• Update the contributing.md file to include detailed instructions for setting up environment variable files on Linux, Windows, and macOS.
• Ensure the documentation explicitly states which options need to be uncommented in the .env file.
• Improve the overall clarity and completeness of the document.

Acceptance Criteria

• The contributing.md file contains clear, detailed instructions for creating and configuring environment variable files on all major operating systems.
• Instructions for uncommenting necessary options in the .env file are included.
• The document is reviewed and approved by at least one other contributor for clarity and completeness.

Tasks

• [ ] Create and initialize a new working branch
  • Use the branch name following the conventions specified in the CONTRIBUTING.md guide.
  • Branch name format: docs/update-contributing-md
• [ ] Update the section on configuring the development environment to include instructions for Linux, Windows, and macOS.
• [ ] Add detailed steps on how to create and configure the .env file, including which options to uncomment.
• [ ] Improve overall clarity and ensure all sections are up to date.
• [ ] Write the commit message
  • Ensure the commit message follows the naming conventions as specified in the CONTRIBUTING.md guide.
• [ ] Create the Pull Request
  • Ensure the Pull Request follows the naming and description conventions as specified in the CONTRIBUTING.md guide.

Resources

• GitHub Documentation on Environment Variables
• Example of Environment Configuration for Multiple OS

UML Diagrams References

• Use Case Diagram: To understand the interactions between the developer and the system during setup.
• Sequence Diagram: To visualize the steps of setting up the environment variables.
• Class Diagram: To see the structure of configuration files and their relations.

Branch Name

docs/update-contributing-md

Complementary Suggested Tasks

• [ ] Ensure compatibility with existing documentation and update any references if necessary.
• [ ] Review and update related configuration settings if required.
• [ ] Perform a walkthrough of the updated setup instructions to ensure clarity and accuracy.