Contributing to RSSCopilot

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

Code of Conduct

Our Code of Conduct is based on the Contributor Covenant. We expect all contributors to uphold these guidelines to ensure a welcoming and inclusive community.

Getting Started

Fork the repository
Clone your fork
Set up development environment (see Getting Started)

Development Process

1. Choose an Issue

Look for issues labeled “good first issue” or “help wanted”
Comment on the issue to express your interest
Wait for assignment or confirmation

2. Create a Branch

git checkout -b feature/your-feature-name

3. Development Guidelines

Code Style

Follow TypeScript best practices
Use ESLint and Prettier
Keep functions small and focused
Write meaningful comments

Testing

Write unit tests for new features
Ensure all tests pass
Add integration tests when needed

Documentation

Update relevant documentation
Add JSDoc comments
Update API reference if needed

4. Commit Guidelines

Commit Message Format

type(scope): subject

body

footer

Types

feat: New feature
fix: Bug fix
docs: Documentation
style: Formatting
refactor: Code restructuring
test: Adding tests
chore: Maintenance

5. Pull Request Process

Update your branch with main

git fetch origin
git rebase origin/main

Push your changes

git push origin feature/your-feature-name

Create Pull Request
- Use the PR template
- Link related issues
- Add description of changes
Code Review
- Address review comments
- Update PR as needed
- Get approval

Release Process

Version Numbers

We use Semantic Versioning:

MAJOR.MINOR.PATCH

Release Steps

Version bump
Update changelog
Create release notes
Tag release
Publish

Additional Resources

Getting Help

Create an issue
Join discussions
Contact maintainers