Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
67 lines (50 loc) · 1.83 KB

CONTRIBUTING.md

File metadata and controls

67 lines (50 loc) · 1.83 KB

Contributing to Auth Starterpack

First off, you're awesome for wanting to contribute! 🎉

Found a bug?

Here's how to report it:

  1. Check if someone already reported it in Issues
  2. If not, create a new one with:
    • How to make the bug happen
    • What should happen
    • What actually happens
    • Screenshots if you can
    • Your browser (Chrome, Safari, etc)

Want to contribute code?

  1. Fork the repo
  2. Create your feature branch: 
    git checkout -b feature/awesome-feature
  3. Make your changes
  4. Test everything works
  5. Push to your fork
  6. Open a Pull Request

Pull Request Tips

Keep these in mind:

  • Focus on one thing at a time
  • Follow the existing style
  • Update docs if needed
  • Explain your changes clearly

Need help?

You can either:

What this project is about

Think of this as the authentication foundation that developers can actually build on. Just like how Shadcn UI revolutionized UI components by making them customizable, we're doing the same for auth.

We focus purely on authentication. That means:

  • ✅ Email verification
  • ✅ Device management
  • ✅ Security alerts
  • ✅ Basic user settings (email, password, name)
  • ❌ In-app notifications (not auth-related)
  • ❌ User profiles (usernames, bios, profile pages, etc)

This keeps the project focused while giving developers a solid foundation they can extend.

We also like simple solutions. That way, the project is easier to pick up on.

Be awesome to each other

A few ground rules:

  • Be kind and helpful
  • Focus on solutions, not blame
  • Welcome newcomers
  • Share knowledge

Let's make authentication great again!