docs(ui): add open source documentation files

This commit is contained in:
Tuan-Dat Tran
2026-02-23 13:48:52 +01:00
parent 36b5a62953
commit 15a5c0a59c
4 changed files with 118 additions and 0 deletions

60
CONTRIBUTING.md Normal file
View File

@@ -0,0 +1,60 @@
# Contributing to CV
Thank you for your interest in contributing!
## Quick Start
1. Fork the repository
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
3. Make your changes
4. Run linting (`npm run lint`)
5. Commit your changes (`git commit -m 'Add amazing feature'`)
6. Push to the branch (`git push origin feature/amazing-feature`)
7. Open a Pull Request
## Development Guidelines
### Code Style
- Follow the existing code style
- Run `npm run lint` before committing
- Use meaningful commit messages
### Component Structure
```jsx
// Imports at top
import { motion } from 'framer-motion';
import { Icon } from 'lucide-react';
// Component definition
export default function Component() {
return (
// JSX
);
}
```
### Testing Your Changes
```bash
# Start dev server
npm run dev
# Build for production
npm run build
# Preview production build
npm run preview
```
## Pull Request Checklist
- [ ] Code follows the existing style
- [ ] Linting passes (`npm run lint`)
- [ ] Build succeeds (`npm run build`)
- [ ] Changes are documented in PR description
## Questions?
Feel free to open an issue for any questions or discussions.