Background pattern

Contribution Guidelines

Clear rules, standards, and best practices for all contributors to follow when submitting code, documentation, or other materials.

View Code Standards Return to Contribute

Developer Contribution Rules

💻

Code Quality

  • • Follow Prettier/ESLint rules for formatting
  • • Include unit tests with all new features
  • • Add TypeScript types when applicable
  • • Add JSDoc comments for public interfaces
View Style Guide
📚�

Pull Request Process

  • • Fork the repository and create feature branches
  • • Include screenshots for UI changes
  • • Add changelog entries for new features
  • • Mention related GitHub issues if applicable
PR Checklist

Technical Writing Standards

📘

Style Guide

  • • Use imperative mood for command instructions
  • • Follow Google Developer Documentation Standards
  • • Include code samples for all API methods
  • • Add screenshots for complex configuration steps
🔄

Formatting Rules

  • • 79 character limit for markdown lines
  • • Include anchors for all section headings
  • • Use consistent indentation (2 spaces)
  • • Add alt texts for all images and diagrams
🔍

Review Process

  • • Assign reviewers based on area of expertise
  • • Include link to live docs preview
  • • Add deprecation notices for outdated content
  • • Include TOC for all guides > 500 words

Community Behavior Guidelines

🤝�

Respect and Inclusion

  • • Treat all participants with respect regardless of skill level
  • • Avoid offensive language or personal attacks
  • • Respect privacy and data sensitivity disclosures
  • • Follow the project's Code of Conduct
🛡

Security & Safety

  • • Never share credentials or sensitive data in public forums
  • • Report vulnerabilities via security@hellenicaos.org
  • • Avoid creating fork bombs or DoS attempts
  • • Follow responsible disclosure policies

How Contributions Work

Follow this structured workflow for submitting any changes to the project.

1

Fork and Branch

Create a personal fork and use feature-specific branches

2

Implement Changes

Write code, updates, and documentation following our style guides

3

Submit PR

Open pull request with clear description and issue reference

4

Review Process

Get feedback, address comments and iterate until merge

Ready to Help Build HellenicaOS?

Your contributions help shape the future of this open-source project through innovative technologies and collaborative development.

View Contribution Guide Ask in Discord