mirror of
https://github.com/Forceu/Gokapi.git
synced 2026-03-31 02:00:30 -05:00
1.4 KiB
1.4 KiB
Contributing to Gokapi
First off, thanks for taking the time to contribute! Gokapi is built to be a lightweight, secure way to share files, and community help is what keeps this project running.
Security First
If you find a security vulnerability, please do not open a public issue. Instead, report it at https://github.com/Forceu/Gokapi/security to allow for a responsible disclosure.
Getting Started
- Fork the repository and clone it locally.
- Ensure you have Go 1.25+ (or the version specified in
go.mod) installed. - Install dependencies:
go mod download. - Create a new branch for your fix or feature:
git checkout -b feat/new-pr-name.
Coding Standards
- Style: Run
go fmt ./...before committing. We follow standard Go idioms. - Tests: If you add a feature, please add a corresponding test in the relevant
_test.gofile. - Documentation: Update the
README.mdor/docsif you change application behaviours or procedures.
Submitting a PR
- Ensure your PR description follows our PR Template.
- Keep PRs focused. If you have two unrelated fixes, please open two PRs.
- Make sure all CI checks pass before requesting a review.
Community & Communication
If you're unsure about an implementation detail, feel free to open a "Draft PR" or start a GitHub Discussion to get feedback early!