Skip to content

Contributing

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

Code of Conduct

Please be respectful and considerate of others when contributing to this project. We expect all contributors to follow our Code of Conduct.

Getting Started

  1. Fork the repository on GitHub
  2. Clone your fork to your local machine
  3. Create a new branch for your changes
  4. Make your changes
  5. Push your changes to your fork
  6. Submit a pull request

Development Environment

To set up your development environment:

# Clone the repository
git clone https://github.com/TFMV/blink.git

# Navigate to the repository
cd blink

# Install dependencies
go mod download

# Build the binary
make build

Project Structure

The project is organized as follows:

  • cmd/blink/: Contains the CLI application
  • cmd/: Contains the Cobra command definitions
  • main.go: Entry point for the CLI
  • pkg/blink/: Contains the library code
  • blink.go: Core functionality
  • filter.go: Event filtering
  • server.go: SSE server
  • webhook.go: Webhook functionality
  • sub.go: Directory scanning
  • time.go: Time-related utilities
  • examples/: Contains example applications
  • docs/: Contains documentation

Testing

Before submitting a pull request, please run the tests:

# Run all tests
make test

# Run tests without integration tests
make test-short

# Run benchmarks
make benchmark

# Generate test coverage
make coverage

Coding Style

We follow the standard Go coding style. Please run gofmt on your code before submitting a pull request:

# Format all Go files
gofmt -s -w .

Documentation

Please update the documentation when adding or changing features. The documentation is written in Markdown and is located in the docs/ directory.

Pull Request Process

  1. Ensure your code passes all tests
  2. Update the documentation if necessary
  3. Update the CHANGELOG.md file if necessary
  4. Submit a pull request with a clear description of the changes

Release Process

  1. Update the version number in cmd/blink/cmd/version.go
  2. Update the CHANGELOG.md file
  3. Create a new tag with the version number
  4. Push the tag to GitHub
  5. Create a new release on GitHub

License

By contributing to this project, you agree that your contributions will be licensed under the project's license.