Skip to content

contributing.md

Latest commit

 

History

History
86 lines (62 loc) · 1.88 KB

contributing.md

File metadata and controls

86 lines (62 loc) · 1.88 KB

Contributing to Scroll

Thanks for your interest in contributing to Scroll! 🎉

Ways to Contribute

🐛 Report Bugs

Open an issue and include:

  • Steps to reproduce
  • Expected behavior
  • Actual behavior
  • Screenshots or screen recordings
  • Browser version
  • Which AI platform (ChatGPT/Claude/Gemini)

💡 Suggest Features

Open an issue describing:

  • The problem you're trying to solve
  • Your proposed solution
  • Why it would benefit other users
  • Any relevant mockups or examples

📖 Improve Documentation

Spot a typo? Unclear instructions? Submit a PR or open an issue.

🔧 Submit Code

  1. Fork the repository

  2. Create a feature branch

   git checkout -b feature/your-feature-name

  1. Make your changes

    • Keep code clean and well-commented
    • Test thoroughly on all three platforms
    • Follow existing code style

  2. Test your changes

    • Load the extension in Chrome
    • Test on ChatGPT, Claude, and Gemini
    • Try different scenarios (long conversations, headings, search, etc.)

  3. Commit with clear messages

   git commit -m "Add feature: description of what you did"
  1. Push to your fork
   git push origin feature/your-feature-name
  1. Open a Pull Request
    • Describe what you changed and why
    • Reference any related issues
    • Include screenshots if relevant

Code Style

  • Use clear, descriptive variable names
  • Comment complex logic
  • Keep functions small and focused
  • Follow existing patterns in the codebase

Testing Checklist

Before submitting a PR, verify:

  • Works on ChatGPT
  • Works on Claude
  • Works on Gemini
  • Keyboard shortcuts work
  • Search/filter works
  • No console errors
  • UI looks good in light and dark mode

Questions?

Open a discussion or reach out on X / Twitter.

Thanks for making Scroll better! 🙏