Thanks for your interest in contributing. This guide covers the workflow for reporting bugs, suggesting changes, and submitting pull requests.
- Fork the repository on GitHub.
- Clone your fork locally:
git clone https://github.com/<your-username>/Portfolio.git cd Portfolio
- Install dependencies:
npm install
- Create a branch for your changes:
git checkout -b your-branch-name
- Start the dev server to test your changes:
npm run dev
This project uses Prettier for formatting and ESLint for linting. Run both before committing:
npm run format
npm run lintTo auto-fix lint issues:
npm run lint:fixPrettier config (from .prettierrc):
- Single quotes
- Semicolons
- Trailing commas
- 100 character print width
- 2 space indentation
Use short, clear commit messages with a conventional prefix:
feat:new feature or componentfix:bug fixdocs:documentation changesstyle:formatting or CSS changes (no logic changes)refactor:code restructuring without changing behavior
Example: feat: add dark mode toggle to navbar
- Make sure your branch is up to date with
main. - Run
npm run lintandnpm run buildto verify nothing is broken. - Open a PR targeting the
mainbranch. - Provide a short description of what changed and why.
- Include screenshots if you changed any UI.
A maintainer will review your PR and may request changes before merging.
Before opening an issue, check if it already exists. If not, include:
- Steps to reproduce the problem
- Expected vs actual behavior
- Your Node.js version and operating system
Open an issue with the enhancement label describing what you would like to see and why it would be useful.