---
title: PR Welcome
description: How to contribute to Vane Project
icon: GitPullRequest
---
import { Cards, Card } from 'fumadocs-ui/components/card';
import { FileText, Github } from 'lucide-react';
We welcome contributions to Vane! Whether you're fixing a typo, improving documentation, or proposing a new feature, your help is appreciated.
## Getting Started
Before you start, please read our core contribution guidelines in the project root.
<Cards>
<Card
href="https://github.com/canmi21/vane/blob/main/CONTRIBUTING.md"
title="General Contributing Guide"
icon={<FileText />}
>
The definitive guide for code contributions, issue reporting, and setup.
</Card>
<Card
href="https://github.com/canmi21/vane/blob/main/CODE_OF_CONDUCT.md"
title="Code of Conduct"
icon={<FileText />}
>
Our pledge to making Vane a harassment-free experience for everyone.
</Card>
</Cards>
## Documentation Roadmap
If you want to help with documentation, check out the following guides to ensure your contributions match our style and standards:
- **[Writing Guide](./contributing/writing-guide)**: Tone, voice, and language rules.
- **[Markdown Style](./contributing/markdown-style)**: Formatting rules, component usage, and diagram standards.
- **[Documentation PR](./contributing/documentation-pr)**: The specific workflow for submitting docs changes.
## Quick Links
- **Repository**: [github.com/canmi21/vane](https://github.com/canmi21/vane)
- **Issues**: [github.com/canmi21/vane/issues](https://github.com/canmi21/vane/issues)