docs(ui): add open source documentation files
This commit is contained in:
1
CODEOWNERS
Normal file
1
CODEOWNERS
Normal file
@@ -0,0 +1 @@
|
|||||||
|
* @tuan-dat-tran
|
||||||
60
CONTRIBUTING.md
Normal file
60
CONTRIBUTING.md
Normal 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.
|
||||||
21
LICENSE
Normal file
21
LICENSE
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
MIT License
|
||||||
|
|
||||||
|
Copyright (c) 2026 Tuan-Dat Tran
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
||||||
36
SECURITY.md
Normal file
36
SECURITY.md
Normal file
@@ -0,0 +1,36 @@
|
|||||||
|
# Security Policy
|
||||||
|
|
||||||
|
## Supported Versions
|
||||||
|
|
||||||
|
| Version | Supported |
|
||||||
|
| ------- | ------------------ |
|
||||||
|
| main | :white_check_mark: |
|
||||||
|
|
||||||
|
## Reporting a Vulnerability
|
||||||
|
|
||||||
|
We take security seriously. If you discover a security vulnerability, please follow these steps:
|
||||||
|
|
||||||
|
1. **Do not** open a public issue
|
||||||
|
2. Email the maintainer directly at `tuan-dat.tran@example.com`
|
||||||
|
3. Include:
|
||||||
|
- Description of the vulnerability
|
||||||
|
- Steps to reproduce
|
||||||
|
- Potential impact
|
||||||
|
- Suggested fix (if any)
|
||||||
|
|
||||||
|
### What to Expect
|
||||||
|
|
||||||
|
- Acknowledgment within 48 hours
|
||||||
|
- Assessment within 7 days
|
||||||
|
- Fix timeline based on severity:
|
||||||
|
- Critical: 24-72 hours
|
||||||
|
- High: 1 week
|
||||||
|
- Medium/Low: Next release
|
||||||
|
|
||||||
|
### Disclosure Policy
|
||||||
|
|
||||||
|
- Please allow time for the fix before public disclosure
|
||||||
|
- Coordinated disclosure is appreciated
|
||||||
|
- Credit will be given in the fix commit
|
||||||
|
|
||||||
|
Thank you for helping keep this project secure!
|
||||||
Reference in New Issue
Block a user