Skip to content

docs: add comprehensive development setup instructions to CONTRIBUTING.md (H7)#8860

Merged
mudler merged 2 commits into
mudler:masterfrom
localai-bot:feature/contributing-setup-instructions
Mar 8, 2026
Merged

docs: add comprehensive development setup instructions to CONTRIBUTING.md (H7)#8860
mudler merged 2 commits into
mudler:masterfrom
localai-bot:feature/contributing-setup-instructions

Conversation

@localai-bot

Copy link
Copy Markdown
Collaborator

Description

This PR addresses issue H7 - Complete CONTRIBUTING.md Development Setup Instructions.

Changes Made

  • Expanded prerequisites section with Go version requirements and installation links for all platforms
  • Added system dependencies for Ubuntu/Debian, CentOS/RHEL/Fedora, macOS, and Windows (WSL)
  • Documented build commands with explanations and key build variables (BUILD_TYPE, GO_TAGS, CUDA versions)
  • Added Environment Variables section with useful development environment variables
  • Included Development Workflow guidelines with branch naming conventions, commit message format, and PR process details
  • Enhanced Testing section with per-package test execution and Ginkgo focus flags

Acceptance Criteria

✅ New contributors can set up development environment following instructions
✅ Go version requirements are clear with installation links
✅ System dependencies are listed by OS with collapsible sections
✅ Build and test commands are provided with explanations
✅ Environment variables are documented
✅ Development workflow guidelines included

Resolves: H7 - Complete CONTRIBUTING.md Development Setup Instructions

…G.md

- Expand prerequisites with Go version requirements and installation links
- Add system dependencies for Ubuntu/Debian, CentOS/RHEL/Fedora, macOS, and Windows
- Document build commands with explanations and key build variables
- Add environment variables section with useful development env vars
- Include development workflow guidelines (branch naming, commit format, PR process)
- Enhance testing section with per-package and focused test instructions
@netlify

netlify Bot commented Mar 8, 2026

Copy link
Copy Markdown

Deploy Preview for localai ready!

Name Link
🔨 Latest commit 055dbee
🔍 Latest deploy log https://app.netlify.com/projects/localai/deploys/69adb15ddec49200080c1121
😎 Deploy Preview https://deploy-preview-8860--localai.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Comment thread CONTRIBUTING.md
Comment thread CONTRIBUTING.md Outdated
Signed-off-by: Ettore Di Giacinto <mudler@users.noreply.github.com>
@mudler mudler merged commit ce33b7e into mudler:master Mar 8, 2026
28 of 31 checks passed
localai-bot added a commit to localai-bot/LocalAI that referenced this pull request Mar 25, 2026
…G.md (H7) (mudler#8860)

* docs: add comprehensive development setup instructions to CONTRIBUTING.md

- Expand prerequisites with Go version requirements and installation links
- Add system dependencies for Ubuntu/Debian, CentOS/RHEL/Fedora, macOS, and Windows
- Document build commands with explanations and key build variables
- Add environment variables section with useful development env vars
- Include development workflow guidelines (branch naming, commit format, PR process)
- Enhance testing section with per-package and focused test instructions

* Apply suggestions from code review

Signed-off-by: Ettore Di Giacinto <mudler@users.noreply.github.com>

---------

Signed-off-by: Ettore Di Giacinto <mudler@users.noreply.github.com>
Co-authored-by: localai-bot <localai-bot@noreply.github.com>
Co-authored-by: Ettore Di Giacinto <mudler@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants