# std-conventions

> General development conventions for project structure, documentation, and version control

- Author: Lilu Douglas
- Repository: devalexanderdaza/opencode-workflow
- Version: 20260114232758
- Stars: 0
- Forks: 0
- Last Updated: 2026-02-06
- Source: https://github.com/devalexanderdaza/opencode-workflow
- Web: https://mule.run/skillshub/@@devalexanderdaza/opencode-workflow~std-conventions:20260114232758

---

---
name: std-conventions
description: General development conventions for project structure, documentation, and version control
---

## General development conventions

- **Consistent Project Structure**: Organize files and directories in a predictable, logical structure that team members can navigate easily
- **Clear Documentation**: Maintain up-to-date README files with setup instructions, architecture overview, and contribution guidelines
- **Version Control Best Practices**: Use clear commit messages, feature branches, and meaningful pull/merge requests with descriptions
- **Environment Configuration**: Use environment variables for configuration; never commit secrets or API keys to version control
- **Dependency Management**: Keep dependencies up-to-date and minimal; document why major dependencies are used
- **Code Review Process**: Establish a consistent code review process with clear expectations for reviewers and authors
- **Testing Requirements**: Define what level of testing is required before merging (unit tests, integration tests, etc.)
- **Feature Flags**: Use feature flags for incomplete features rather than long-lived feature branches
- **Changelog Maintenance**: Keep a changelog or release notes to track significant changes and improvements