Skip to content

Latest commit

 

History

History
80 lines (56 loc) · 1.75 KB

CONTRIBUTING.md

File metadata and controls

80 lines (56 loc) · 1.75 KB

Contributing to TabSum AI

First off, thank you for considering contributing to TabSum AI! 🎉 It's people like you that make TabSum AI such a great tool.

Ways to Contribute

There are many ways you can contribute to TabSum AI:

  1. 🐛 Report bugs
  2. 💡 Suggest new features
  3. 📝 Improve documentation
  4. 🔧 Submit pull requests

Getting Started

  1. Fork the repository
  2. Clone your fork: 
    git clone https://github.com/your-username/tabsum-ai.git
  3. Create a new branch: 
    git checkout -b feature/your-feature-name

Development Setup

  1. Create a config.js file with your Gemini Pro API key
  2. Load the extension in Chrome:
    • Go to chrome://extensions/
    • Enable "Developer mode"
    • Click "Load unpacked"
    • Select the project directory

Pull Request Process

  1. Update the README.md with details of changes if needed
  2. Follow the existing code style
  3. Write clear commit messages
  4. Push to your fork and submit a pull request

Code Style

  • Use ES6+ features
  • Follow consistent indentation (2 spaces)
  • Add comments for complex logic
  • Keep functions small and focused

Bug Reports

When filing an issue, make sure to answer these questions:

  1. What version of Chrome are you using?
  2. What did you do?
  3. What did you expect to see?
  4. What did you see instead?

Feature Requests

We love features that:

  • Align with the project's goals
  • Have minimal dependencies
  • Are well-documented
  • Include tests (if applicable)

Community

  • Be welcoming to newcomers
  • Be respectful of differing viewpoints
  • Accept constructive criticism
  • Focus on what is best for the community

Questions?

Feel free to contact the project maintainers if you have any questions!

Thank you for contributing! 🙏