Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
32 lines (21 loc) · 1.25 KB

CONTRIBUTING.md

File metadata and controls

32 lines (21 loc) · 1.25 KB
Raw

Contributing to Proton

Thank you for your interest in contributing to Proton! We welcome bug reports, feature requests, and pull requests to help make this Go GUI library better.

Want to contribute?

We are open to accepting new contributors! If you would like to join the project, please open a pull request. We will review your GitHub profile and projects before making a decision.

Prerequisites

To contribute, you should have:

  • At least one active/high-quality GitHub repository.
  • Experience as a Go developer.
  • Good knowledge of GUI toolkits (especially immediate mode ones like Gio).

Getting Started & Prerequisites

Because Proton interacts directly with system graphics, you need to ensure your local development environment has the necessary dependencies installed before compiling.

Dependencies

  • Go: Version 1.21 or higher is recommended.
  • Linux Users: Ensure you have X11/Wayland development packages installed (e.g., libwayland-dev, libx11-dev depending on your specific window manager engine).
  • Windows/macOS: Standard Go installation should work out of the box.

Local Setup

  1. Fork the repository on GitHub.
  2. Clone your fork locally: 
          git clone https://github.com/CzaxStudio/proton.git