tdpeuter/2026SEL3-project-Brittle_Star_Controller_Modularity
tdpeuter/2026SEL3-project-Brittle_Star_Controller_Modularity
Archived
1
Fork 0
Code Issues Releases Activity

docs: update documentation for logging and configuration

Browse source 
- Add Quick Start guide with installation and configuration steps
- Document unified logging framework features
- Explain configuration management for multiple researchers
- Add project structure overview showing experiment_logger
- Update training examples with new patterns
- Add logging best practices to CONTRIBUTING.md
This commit is contained in:
Tibo De Peuter 2026-03-31 19:53:45 +00:00
parent f31436bccd
commit 7fe217de0f
2 changed files with 78 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

9
docs/CONTRIBUTING.md
View file

@ -33,3 +33,12 @@ Code readability is paramount, as code is read far more frequently than it is wr
* **Simulation:** The simulation environment utilizes a MuJoCo brittle star. XML MuJoCo structures must remain realistic and respect morphological constraints.
* **Experiment Tracking:** Weights & Biases (wandb) must be utilized for tracking and logging all experiments.
* **Code Styling:** All code must conform to the chosen style guide (i.e. Google standard). This is enforced using build tools and pre-commit hooks such as flake8, black, or isort.
## 5. AI-Assisted Development & Code Review
This project supports AI-assisted development to enhance productivity, but contributors must take full responsibility for all AI-generated outputs.
* **Self-Review Requirement:** Contributors must thoroughly self-review all AI-assisted code, documentation, and configurations before requesting peer review. This includes verifying correctness, adherence to project standards, scientific validity, and integration with existing code.
* **Quality Standards:** AI-generated content must meet the same rigorous standards as manually written code, including proper testing, documentation, and alignment with the scientific methodology outlined in Section 1.
* **Available Skills:** This project provides specific AI skills for common tasks (located in `.agents/skills/`), including linting and testing workflows. Contributors should leverage these skills to maintain consistency and quality.
* **Transparency:** When using AI assistance for complex algorithmic decisions or scientific design choices, contributors should document the rationale in commit messages or code comments where appropriate.