Contributing¶

Welcome to the Genifest project! We appreciate your interest in contributing.

Work in Progress

This documentation page is being developed. Please check back soon for complete content.

Getting Started¶

Prerequisites¶

Go 1.24 or later
Git
Make (optional but recommended)

Development Setup¶

Fork and clone the repository:

git clone https://github.com/yourusername/genifest.git
cd genifest

Install dependencies:

make deps
# or manually:
go mod download

Install development tools:
```
make tools
```
Run tests:
```
make test
```
Build the project:
```
make build
```

Development Workflow¶

Making Changes¶

Create a feature branch:

git checkout -b feature/your-feature-name

Make your changes

Run quality checks:

make check  # Runs fmt, vet, lint, and test

Commit your changes:

git add .
git commit -m "feat: add your feature description"

Commit Message Format¶

We follow conventional commit format:

feat: - New features
fix: - Bug fixes
docs: - Documentation updates
test: - Test additions/updates
chore: - Maintenance tasks

Pull Request Process¶

Push your branch:

git push origin feature/your-feature-name

Create a pull request
Address review feedback
Ensure CI passes

Code Style¶

Follow Go conventions and best practices
Use gofmt for formatting
Run golangci-lint before submitting
Write tests for new functionality
Add documentation for user-facing features

Testing¶

Running Tests¶

# All tests
make test

# Tests with coverage
make test-coverage

# Race detection
make test-race

# Short tests only
make test-short

Writing Tests¶

Write unit tests for new functions
Add integration tests for complex features
Use the guestbook example for end-to-end testing

Documentation¶

Building Documentation¶

# Install docs dependencies
make docs-install

# Serve locally
make docs-serve

# Build static site
make docs-build

Documentation Guidelines¶

Update documentation for user-facing changes
Use clear, concise language
Provide examples where helpful
Test documentation locally before submitting

Release Process¶

Releases are handled by maintainers. Contributors should:

Update CHANGELOG.md for significant changes (use the heading ## WIP TBD to start a new section at the top of the file)
Ensure version compatibility
Update documentation as needed