Skip to main content

Contributing to Juniro

Guidelines for contributing to Juniro's codebase and documentation

🎯 Overview​

This document outlines the standards and processes for contributing to any Juniro repository, ensuring consistency across our development workflow.

📋 General Guidelines​

Code Standards​

Documentation Standards​

  • Update documentation for any new features
  • Follow our Documentation Strategy
  • Include examples and usage instructions

Review Process​

  • All changes require peer review
  • Address feedback promptly and professionally
  • Ensure CI/CD checks pass

🔧 Development Workflow​

Setup​

  1. Clone the repository
  2. Install dependencies
  3. Create a feature branch
  4. Make your changes
  5. Test thoroughly
  6. Submit a pull request

Branch Naming​

feature/description-of-feature
bugfix/description-of-bug
hotfix/critical-issue-description

Commit Standards​

Use our Git Aliases for consistent commit formatting:

git feat "add user authentication"
git fix "resolve login validation issue"
git docs "update API documentation"

🛡️ Security Guidelines​

  • Follow our Security Guidelines
  • Never commit sensitive information
  • Report security issues privately
  • Use secure coding practices

📞 Getting Help​

  • Check existing documentation first
  • Ask questions in team channels
  • Reach out to project maintainers
  • Create an issue for bugs or feature requests

🔧 Development Process​

📋 Templates & Guidelines​

🏗️ Architecture & Design​

This guide ensures consistent, high-quality contributions across all Juniro projects.