Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
63 lines (46 loc) · 1.75 KB

CONTRIBUTING.md

File metadata and controls

63 lines (46 loc) · 1.75 KB
Raw

Contributing to BYOS Next.js for TRMNL 🚀

Thanks for your interest in contributing to this project! This is a casual, community-driven project, and we welcome contributions of all kinds.

Ways to Contribute

🐞 Report Bugs

Found something that's not working? Let us know by opening an issue! Include:

  • What you were trying to do
  • What you expected to happen
  • What actually happened
  • Steps to reproduce the issue
  • Your environment (OS, Node version, etc.)

💡 Suggest Features

Have an idea to make this project better? Open an issue with:

  • A clear description of what you'd like to see
  • Why it would be useful
  • Any implementation ideas you have

🔧 Submit Code

Want to fix a bug or add a feature yourself? Great!

  1. Fork the repo
  2. Create a branch (git checkout -b cool-new-feature)
  3. Make your changes
  4. Test your changes
  5. Commit (git commit -m 'Add some feature')
  6. Push to your branch (git push origin cool-new-feature)
  7. Open a Pull Request

📚 Improve Documentation

Documentation improvements are always welcome! Fix typos, add examples, or clarify confusing sections.

Development Setup

# Clone the repo
git clone https://github.com/usetrmnl/byos_next.git
cd byos_next

# Install dependencies
pnpm install  # or npm install or yarn

# Start the dev server
pnpm run dev  # or npm run dev or yarn dev

Code Style

We're not super strict, but please try to follow the existing style:

  • Use TypeScript when possible
  • Use functional React components with hooks
  • Format your code using Biome (run pnpm lint to check, pnpm format to auto-fix)
  • Add comments for non-obvious code

Questions?

If you have questions, just open an issue! We're a friendly community and happy to help.

Happy Coding! 🚀