Contributing to go-feed

August 1, 2025 · View on GitHub

Thank you for your interest in contributing to go-feed! We welcome contributions from everyone.

Code of Conduct
Getting Started
Development Setup
How to Contribute
Pull Request Process
Coding Standards
Testing
Documentation
Community

Code of Conduct

This project adheres to a Code of Conduct. By participating, you are expected to uphold this code.

Getting Started

Fork the repository on GitHub
Clone your fork locally
Set up the development environment
Create a new branch for your feature or bug fix
Make your changes
Test your changes
Submit a pull request

Development Setup

Prerequisites

Go 1.22 or later
Git

Setup Instructions

# Clone your fork
git clone https://github.com/your-username/go-feed.git
cd go-feed

# Install dependencies
go mod download

# Run tests to verify setup
go test ./...

How to Contribute

Reporting Bugs

Before creating bug reports:

Check if the issue already exists in GitHub Issues
Use the latest version of go-feed
Provide detailed information about your environment

When submitting a bug report, include:

Go version (go version)
Operating system
Detailed description of the issue
Steps to reproduce
Expected vs actual behavior
Code samples or error messages

Suggesting Features

Feature requests are welcome! Please:

Check existing issues for similar requests
Clearly describe the feature and its use case
Explain why it would be beneficial
Consider implementation complexity

Code Contributions

We welcome code contributions for:

Bug fixes
New features
Performance improvements
Documentation improvements
Test coverage improvements
Framework adapters

Pull Request Process

Create a Branch: Create a feature branch from master
```
git checkout -b feature/your-feature-name
```
Make Changes: Implement your changes following our coding standards
Test: Ensure all tests pass and add new tests for your changes
```
go test ./...
go test -race ./...
```
Document: Update documentation and examples as needed

Commit: Use clear, descriptive commit messages

git commit -m "feat: add RSS feed validation support"

Push: Push your branch to your fork

git push origin feature/your-feature-name

Submit PR: Create a pull request against the master branch

Pull Request Guidelines

Provide a clear description of the changes
Reference any related issues
Include tests for new functionality
Update documentation as needed
Ensure CI checks pass
Be responsive to feedback

Coding Standards

Go Style

Follow Effective Go
Use go fmt for formatting
Use go vet for static analysis
Follow Go naming conventions
Add comments for exported functions and types

Code Organization

Keep functions focused and small
Use meaningful variable and function names
Organize code into logical packages
Avoid deep nesting

Error Handling

Handle errors explicitly
Provide meaningful error messages
Use custom error types when appropriate
Don't ignore errors

Example

// AddItem adds a feed item with validation.
func (f *Feed) AddItem(item Item) error {
    if err := item.Validate(); err != nil {
        return fmt.Errorf("invalid feed item: %w", err)
    }
    
    f.items = append(f.items, item)
    return nil
}

Testing

Test Requirements

All new code must include tests
Aim for high test coverage (>90%)
Write both unit and integration tests
Test edge cases and error conditions

Running Tests

# Run all tests
go test ./...

# Run tests with coverage
go test -cover ./...

# Run tests with race detection
go test -race ./...

# Generate coverage report
go test -coverprofile=coverage.out ./...
go tool cover -html=coverage.out