Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
50 lines (36 loc) · 1.3 KB

CONTRIBUTING.md

File metadata and controls

50 lines (36 loc) · 1.3 KB
Raw

🤝 Contributing to React SVG Inliner

We welcome all contributions! Whether it’s fixing bugs, adding features, improving documentation, or writing tests, your help makes this project better. 🚀

📌 Guidelines

  1. Fork & Clone

    • Fork the repository to your account.
    • Clone it locally: 
      git clone https://github.com/codejovz/react-svg-inliner.git

  2. Create a Branch

    • Always create a new branch for your changes: 
      git checkout -b feature/my-feature

  3. Pull Requests

    • Once your changes are ready, push your branch and open a pull request.
    • Describe your changes clearly and link any related issues.

  4. Keep Project Structure 🏗️

    • Please do not change the existing project structure.
    • Keep the src/, dist/, package.json, tsconfig.json, etc. as-is.

  5. Tests ✅

    • Tests are welcome and encouraged!
    • If you add new features, please consider adding test coverage.

📝 TODO List

  • ❓

💡 Tips

  • Write clear commit messages.
  • Follow existing code style (TypeScript + React + "use client" convention).
  • Ensure your branch passes any existing lint or build scripts: 
    npm install
npm run build
npm run lint