Skip to content

Commit 1a6f5f6

Browse files
committed
docs: include code style/messaging guides
1 parent 2458823 commit 1a6f5f6

1 file changed

Lines changed: 13 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,16 @@ This document covers **development rules and conventions** specific to this repo
99
### 1. Dependencies — Pin All Versions
1010

1111
**All dependencies must use exact, pegged versions** (no `^`, `~`, or `*` ranges). This prevents version drift across environments and ensures reproducible builds for security.
12+
13+
## Local Development
14+
15+
To develop the `arena-account` locally:
16+
1. Run `init-config.sh` in the parent `arena-services-docker` directory to generate the required `.env` secrets and configuration files.
17+
2. Start the local stack using `docker-compose -f docker-compose.localdev.yaml up -d arena-account`
18+
3. The Django source folder is mounted via the localdev compose file. For testing or migrations, you can exec into the container and use `manage.py`.
19+
20+
## Code Style
21+
- Follow standard Python formatting guidelines (`black` and `PEP 8`).
22+
- Ensure all HTTP handlers return standard JSON payloads.
23+
24+
The `arena-account` uses [Release Please](https://github.com/googleapis/release-please) to automate CHANGELOG generation and semantic versioning. Your PR titles *must* follow Conventional Commit standards (e.g., `feat:`, `fix:`, `chore:`).

0 commit comments

Comments
 (0)