Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
156 lines (111 loc) · 3.29 KB

CONTRIBUTING.md

File metadata and controls

156 lines (111 loc) · 3.29 KB

Contributing to Supawald

Thank you for your interest in contributing to Supawald! This document provides guidelines and steps for contributing to the project.

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct. Please report unacceptable behavior to the project maintainers.

How to Contribute

Reporting Bugs

  1. Check if the bug has already been reported in the issues section
  2. If not, create a new issue with:
    • A clear description of the bug
    • Steps to reproduce
    • Expected behavior
    • Actual behavior
    • Screenshots (if applicable)
    • Your environment details (OS, Node.js version, etc.)

Suggesting Enhancements

  1. Check if the enhancement has already been suggested
  2. Create a new issue with:
    • A clear description of the enhancement
    • Why this enhancement would be useful
    • Any specific implementation ideas you have

Pull Requests

  1. Fork the repository
  2. Create a new branch for your feature/fix: 
    git checkout -b feature/your-feature-name
# or
git checkout -b fix/your-fix-name
  3. Make your changes
  4. Write/update tests if applicable
  5. Update documentation if needed
  6. Commit your changes with clear commit messages
  7. Push to your fork
  8. Create a Pull Request

Development Setup

  1. Clone your fork:

    git clone https://github.com/your-username/supawald.git
cd supawald

  2. Install dependencies:

    npm install

  3. Copy the environment file:

    cp .env.example .env.local

  4. Update .env.local with your Supabase credentials

  5. Start the development server:

    npm run dev

Code Style

  • Follow the existing code style
  • Use TypeScript for all new code
  • Use meaningful variable and function names
  • Add comments for complex logic
  • Keep functions focused and small
  • Use proper error handling

Testing

  • Write tests for new features
  • Ensure all tests pass before submitting PR
  • Update tests when modifying existing features

Documentation

  • Update README.md if needed
  • Add comments for complex code
  • Update API documentation if applicable

Questions?

Feel free to open an issue for any questions or concerns about contributing.

Thank you for contributing to Supawald!

📦 Publishing to npm

To publish updates to the create-supawald package and tie it to the GitHub repo, follow these steps:

🔗 1. Add GitHub Metadata to package.json

Make sure the root-level package.json includes this:

"repository": {
  "type": "git",
  "url": "https://github.com/StructuredLabs/supawald.git"
},
"bugs": {
  "url": "https://github.com/StructuredLabs/supawald/issues"
},
"homepage": "https://github.com/StructuredLabs/supawald#readme"

This links the npm package back to the official GitHub repo.

🏷️ 2. Tag the Release in Git

After bumping the version in package.json, tag and push the release:

git add .
git commit -m "v1.0.0 release"
git tag v1.0.0
git push origin main --tags

Use the same version number as in package.json.

🚀 3. Publish to npm

If you're not already logged in:

npm login

Then publish the package:

npm publish --access public

The CLI will then be available via:

npx create-supawald my-app