CONTRIBUTING.md

Contributing to Github Readme Suno Cards

Thank you for your interest in contributing! This guide explains how to get involved.

How to Contribute

Reporting Bugs

If you find a bug, please open an issue with:

• Steps to reproduce the problem
• Expected vs. actual behavior (screenshots or logs help)
• Your environment (OS, and relevant runtime/version)

Suggesting Features

Have an idea? Open a feature request describing the problem you want to solve and your proposed solution.

Submitting Changes

1. Fork the repository and clone your fork:

   git clone https://github.com/<your-username>/github-readme-suno-cards.git
   cd github-readme-suno-cards

2. Create a branch for your changes:

   git checkout -b feature/your-feature-name

3. Make your changes and verify them locally (see Development Setup below).
4. Commit with a clear message following Conventional Commits:

   git commit -m "feat: short description of your change"

5. Push and open a Pull Request against the main branch.

Development Setup

# Install dependencies
npm install

# Start the development server
npm run dev

# Production build
npm run build

# Run the test suite
npm test

Code of Conduct

By participating, you agree to abide by our Code of Conduct. For questions or support, see SUPPORT.md. For security issues, see SECURITY.md.