Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
82 lines (53 loc) · 1.82 KB

CONTRIBUTING.md

File metadata and controls

82 lines (53 loc) · 1.82 KB

🤝 Contributing to betterfetch/website

First off, thanks for taking the time to contribute! 🙌
We welcome pull requests, suggestions, and ideas to improve the website for betterfetch.

📦 Setup Instructions

If you haven't already, fork and clone the repository:

git clone https://github.com/betterfetch/website.git
cd website
pnpm install
pnpm dev

🛠️ How to Contribute

1. Fork the Repository

Click the "Fork" button at the top right of the repo.

2. Create a Feature Branch

git checkout -b feature/your-feature-name

3. Make Your Changes

  • Follow the existing project structure and conventions
  • Use Tailwind CSS and DaisyUI for styling
  • Keep components modular and clean
  • Preview your changes locally using pnpm dev

4. Commit Your Changes

git add .
git commit -m "feat: brief description of your change"

5. Push and Open a PR

git push origin feature/your-feature-name

Then go to GitHub and open a pull request against the main branch.

✅ Pull Request Checklist

Before submitting your pull request, make sure:

  • The code runs without errors
  • Your feature or fix is clearly described
  • The UI matches the design and theme
  • Your code follows the existing formatting and stfructure
  • You've tested the functionality in your browser

🧪 Development Notes

💬 Need Help?

Feel free to open an issue or start a discussion!
We love hearing your thoughts, suggestions, and feedback.

Thanks again for contributing 💙