Update to Akeru.ai Project Documentation and Standards

[resourcefulmind]

This pull request represents a significant enhancement to the Akeru.ai project documentation and standards framework. Initially tasked with updating the Contributing Guidelines, the scope expanded to ensure the project's documentation met world standards, resulting in a series of structured and detailed documents tailored for current and future contributors.

Key Changes

1. Contributing Guidelines: Updated to provide clear instructions on how contributors can participate in the project. This was the foundation of our documentation overhaul to ensure that all participants understand the process and expectations.
2. Code of Conduct: Developed a new Code of Conduct to foster an inclusive and respectful community. This document is crucial for setting the behavioral standards and ensuring a welcoming environment for all contributors.
3. Coding Conventions: Created comprehensive Coding Conventions to standardize coding practices across Akeru.ai, enhancing code readability, maintainability, and quality.
4. Documentation Style Guide: Compiled a Documentation Style Guide to ensure consistency and clarity across all project documentation, aiding in the maintainability and scalability of project information.
5. Issues Template: Designed to streamline the process of reporting issues, making it easier for contributors to provide all necessary information, which helps maintainers address issues more efficiently.
6. Pull Request Template: Established to standardize the submission of pull requests, ensuring that all contributions are well-documented and easy to review, facilitating smoother integration and collaboration.

Rationale for Creation

• The Contributing Guidelines was initially created to enhance clarity and provide a solid foundation for new contributors.
• Recognizing the need for a supportive community environment led to the creation of the Code of Conduct.
• To maintain high code quality and uniformity, the Coding Conventions were developed.
• Observing varying documentation standards necessitated the formulation of the Documentation Style Guide.
• To improve issue reporting and resolution efficiency, an Issues Template was needed.
• A Pull Request Template was essential for maintaining consistency in how contributions are reviewed and integrated.

Visual Enhancements

• Future updates will include diagrams and workflows in the Documentation Style Guide to visually represent processes and standards.

Link to Issues

• This comprehensive update addresses several underlying needs identified in issue #63

Request for Review

• @GuiBibeau

[vercel[bot]]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated (UTC)
akeru-akeru-frontend	✅ Ready (Inspect)	Visit Preview	Apr 22, 2024 5:40pm