Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
51 lines (36 loc) · 973 Bytes

CONTRIBUTING.md

File metadata and controls

51 lines (36 loc) · 973 Bytes

Contributing to HMS TZ

This document provides guidelines for contributing to the HMS TZ Frappe app.

Prerequisites

  • Python 3.10+
  • Node.js 18+
  • MariaDB 10.6+
  • Redis
  • Frappe Bench (version-15)

Development Setup

# in your bench
cd ~/frappe-bench
bench get-app hms_tz <repo-url>
bench --site your-site.local install-app hms_tz

# install pre-commit hooks
cd apps/hms_tz
pre-commit install

Making Changes

  • Create a feature branch off version-15-beta.
  • Keep changes focused and add tests where applicable.
  • Run linters before pushing:
pre-commit run --all-files

Commit Guidelines

We use Conventional Commits:

<type>(<scope>): <description>

Allowed types include: feat, fix, docs, style, refactor, perf, test, build, ci, chore, revert, patch.

Pull Request Checklist

  • Code follows project style
  • pre-commit passes
  • Tests pass (when applicable)
  • Documentation updated (if needed)