Development on BWRGY

Developer Onboarding

Mon, 01 Jan 0001 00:00:00 +0000

Getting Started

Welcome to the development team! This guide will help you get up to speed with our codebase, workflows, and team culture. Make sure you’ve checked out our General Onboarding beforehand. Follow the steps below to ensure a smooth onboarding experience.

Prerequisites

Complete these prerequisites before Call 1.

1. GitLab Access Setup

We use GitLab as our primary development and project management platform.

See GitLab Guide for application overview and setup instructions.

Environment Setup

Mon, 01 Jan 0001 00:00:00 +0000

Overview

This guide will help you get our documentation (Hugo) website running locally for development and contribution.

Prerequisites: Before beginning, ensure you’ve completed the GitLab setup in our handbook, including SSH key configuration and repository access.

Step 1: Install Required Tools

macOS:

brew install hugo git go

export GOPATH=$HOME/go
export PATH=$PATH:$GOPATH/bin

source ~/.zshrc # or source ~/.bashrc

Windows:

Download Hugo from releases page
Download Git from git-scm.com
Download Go from golang.org/dl
Add all tools to your PATH environment variable

Linux:

Contributing

Mon, 01 Jan 0001 00:00:00 +0000

Overview

Please Do

Check if there is an existing issue before submitting a new one
Open an issue if:
- Something isn’t working as expected
- You’re proposing a significant change
- You’re suggesting a new feature
Open a merge request (MR) to:
- Implement a change discussed in an issue (link the related issue)

In general, open an issue before submitting a merge request. It improves visibility, avoids duplicate work, and allows early feedback.

Communication

Mon, 01 Jan 0001 00:00:00 +0000

Core Practices

MR discussions stay in the MR: Use comments and threads to capture all decisions and changes.
Project-wide updates via Element: Use the Team: Devroom for updates, questions, and async check-ins.
Fortnightly engineering calls: Used for check-ins, blockers, or architectural discussions that require live input.
Write before you speak: Prefer documenting your thoughts over unscheduled pings.

Tools

Tool	Purpose
GitLab	Issues, Merge Requests, technical discussion
Element	Team chat, async updates, questions
Handbook	Long-term documentation and decisions

Expectations

Keep MR threads clear, focused, and self-contained
Use threads in Element to reduce noise
Post blockers or major updates before calls
Document meeting outcomes for future reference