Documentation: Consolidate style guide instructions.

lucawrabetz / opti-face

A suite of tools for automating experiments in computational research.

MIT License

9 stars 1 forks source link

Documentation: Consolidate style guide instructions. #4

Open lucawrabetz opened 6 months ago

lucawrabetz commented 6 months ago

Overview

Add style guides and add appropriate references to them throughout documentation.

Improvement Details

The project should have clear and consistent style preferences and instructions for commit messages, bug reports, code, code comments, TODOs, pull requests, merge messages.

Content Suggestions

Files to be reviewed that will have to refer to style guides: CONTRIBUTING.md

lucawrabetz commented 6 months ago

Further notes:

Content should match everything agreed upon in #6 , #5. All TODOs related to this issue in CONTRIBUTING.md should be addressed to close it.