Welcome Contributors

Contributing Guide

Thank you for your interest in improving SkyAIApp documentation! Every contribution makes our docs better.

Ways to Contribute

Report Issues

Found an error or inaccuracy? Let us know!

Suggest Improvements

Got ideas to make docs better? We'd love to hear

Submit Pull Requests

Contribute code and documentation changes

Join Discussions

Share experiences and best practices

Quick Start

1. Fork the Repository

# Clone your fork
git clone https://github.com/YOUR_USERNAME/skyaiapp-docs.git
cd skyaiapp-docs

# Add upstream remote
git remote add upstream https://github.com/skyaiapp/docs.git

2. Create a Branch

# Create a feature branch
git checkout -b docs/improve-quickstart

# Or fix a bug
git checkout -b fix/typo-in-api-docs

3. Make Changes

Edit Markdown files or React components. Make sure to follow our style guide.

# Install dependencies
npm install

# Start dev server
npm run dev

# Run linter
npm run lint

4. Commit Changes

# Stage changes
git add .

# Commit with descriptive message
git commit -m "docs: improve quickstart guide clarity"

# Push to your fork
git push origin docs/improve-quickstart

5. Create Pull Request

Create a PR on GitHub describing your changes and motivation.

Contribution Guidelines

Code Style

Use TypeScript type definitions
Follow ESLint rules
Keep components concise
Add appropriate comments

Documentation Writing

Use clear and concise language
Provide code examples
Include real-world use cases
Maintain consistent terminology

Community Behavior

Be respectful and friendly
Provide constructive feedback
Help other contributors
Follow code of conduct

Thank You to All Contributors

All contributors are recognized on our contributors page. Your help means a lot to us!

View Contributors

Changelog

Status Page

Was this page helpful?

Let us know how we can improve