@pinkpixel/prysm-mcp/prysm-llm/CONTRIBUTING.md

MCP server for the Prysm web scraper - enabling AI assistants to scrape web content

# 🤝 Contributing to Prysm

Thank you for your interest in contributing to Prysm! This document provides guidelines and instructions for contributing to the project.

## 🌟 Ways to Contribute

- **Code contributions**: Bug fixes, new features, or improvements
- **Documentation**: Improving, extending, or correcting documentation
- **Bug reports**: Submit detailed bug reports via GitHub issues
- **Feature requests**: Suggest new features or improvements
- **Testing**: Help test the scraper on different websites and report your findings

## 🔄 Contribution Workflow

1. **Fork** the repository
2. **Clone** your fork locally: `git clone https://github.com/your-username/prysm.git`
3. **Create a branch**: `git checkout -b feature/my-feature` or `git checkout -b fix/my-bugfix`
4. **Make your changes**
5. **Test your changes**: Ensure your changes work as expected
6. **Commit your changes**: Follow the commit message format below
7. **Push to your fork**: `git push origin feature/my-feature`
8. **Submit a Pull Request**: Include a clear description of your changes

## 📋 Pull Request Process

1. Ensure your PR addresses a specific issue or clearly documents the purpose of your changes
2. Update the README.md and documentation if your changes affect usage
3. Update the CHANGELOG.md following the format in the file
4. Your PR will be reviewed by maintainers who may suggest changes
5. Once approved, your PR will be merged

## 💬 Commit Message Format

Follow this format for commit messages:

```
type(scope): Brief description of change

Detailed description of change if needed.

Resolves: #issue-number
```

Where `type` is one of:

- **feat**: A new feature
- **fix**: A bug fix
- **docs**: Documentation changes
- **style**: Formatting changes (white-space, formatting, etc.)
- **refactor**: Code changes that neither fix bugs nor add features
- **perf**: Performance improvements
- **test**: Adding or updating tests
- **chore**: Maintenance tasks, dependency updates, etc.

And `scope` is the area of the codebase your changes affect (e.g., scraper, api, pagination).

## 📊 Code Style & Standards

- Use 2 spaces for indentation
- Use descriptive variable and function names
- Add comments for complex logic
- Follow existing patterns and conventions in the codebase
- Write tests for new features or bug fixes
- Ensure your code passes all existing tests

## 🧪 Testing

Before submitting a PR, test your changes on various websites, especially:

- Content-heavy sites
- Sites with dynamic content loading
- Sites with different content structures
- Sites with pagination

## 📜 Code of Conduct

- Be respectful and inclusive
- Focus on constructive feedback
- Help other contributors when possible
- Respect the maintainers' decisions

## ❓ Questions?

If you have any questions or need clarification, feel free to:

- Open an issue with your question
- Reach out to the maintainers

Thank you for contributing to Prysm! Your help makes this project better for everyone.

✨ Dream it, Pixel it | Made with ❤️ by Pink Pixel