Contributing Guidelines

This document outlines the code contribution workflow and standards for the OCTAVIUS project.

Contribution Workflow

Branch Strategy

All contributions must follow a feature-branch workflow:

Fork the repository or create a feature branch from the dev branch
Implement changes in a focused, well-scoped manner (avoid monolithic pull requests)
Commit changes with clear, descriptive commit messages
Submit pull requests targeting the dev branch, not main

Code Quality Standards

Before submitting a pull request:

Ensure all existing tests pass: execute the full test suite
Provide clear documentation of:
- The functional changes introduced
- Testing methodology (automated tests + manual steps if applicable)
- Visual evidence (screenshots, diagrams) for UI changes
Follow the repository’s established code conventions and style guidelines
Refactor existing code to maintain consistency with the codebase

Pull Request Process

Submit the pull request with a comprehensive description of changes
Notify repository administrators and code owners
Address reviewer feedback and perform requested revisions
Upon approval, the pull request will be merged into the dev branch
Periodically, the dev branch is merged into main for release

Documentation Requirements

Priority areas for documentation include:

API Development

Endpoint specifications and parameter documentation
Resolver function signatures and expected behavior
Data model definitions and validation rules
Example requests and responses

User Interface Development

Component architecture and hierarchy
Route definitions and navigation flow
State management patterns
Integration with API methods

Code Style Conventions

Follow established conventions in the repository. If conventions are not explicitly documented, maintain consistency with existing code patterns:

Variable naming conventions
Function organization and structure
Test organization and naming patterns
Commit message formatting

Support

For questions regarding contribution procedures or code standards, contact the project administrator.