This repository serves as the central configuration and health repository for Ambibuzz Technologies LLP. It mirrors the special .github repository pattern supported by GitHub to provide default community health files and configurations for the organization.

• Purpose
• Tools & Configurations
  • Python Linting & Formatting (ruff.toml)
  • Commit Message Linting (commitlint.config.js)
  • Pre-commit Hooks (.pre-commit-config.yaml)
• Workflows (GitHub Actions)
• Setup Instructions
• Repository Structure
• Contact

The primary purpose of this repository is to store reusable configurations and workflows that can be inherited or referenced by other repositories within the organization. This ensures consistency in coding standards, commit messages, and CI/CD processes.

The following tools and configurations are maintained in this repository:

We use Ruff for extremely fast Python linting and formatting.

• Config File: ruff.toml
• Settings:
  • Target Python Version: 3.10
  • Line Length: 110
  • Indent Style: Tab
  • Rules: Flake8 (F), pycodestyle (E, W), isort (I), pyupgrade (UP), bugbear (B), and Ruff specific rules (RUF).

We enforce Conventional Commits to ensure a clean and structured commit history.

• Config File: commitlint.config.js
• Standard: Conventional Commits (via @commitlint/config-conventional)

A set of Git hooks to automatically identify and fix issues before code is committed.

• Config File: .pre-commit-config.yaml
• Hooks:
  • trailing-whitespace
  • end-of-file-fixer
  • check-yaml, check-json, check-toml
  • ruff-check & ruff-format (Python)
  • prettier (JS, CSS, SCSS, etc.)
  • commitlint (Commit messages)

To ensure code quality and consistency, please set up the Git hooks locally:

1. Install pre-commit:

   pip install pre-commit

2. Install the hooks:

   pre-commit install
   pre-commit install --hook-type commit-msg

GitHub Actions workflows are located in .github/workflows/ and can be used for checking code quality across repositories.

• pylint.yml: Runs Pylint checks.
• jslint.yml: Runs JavaScript linting.
• review.yml: General review workflow.

• Pull Request Template: Located at .github/PULL_REQUEST_TEMPLATE.md, this template is automatically applied to new Pull Requests in the organization to guide contributors in providing necessary context.

• Repository Structure:A quick overview of the key files and folders:

├── .github/
│   ├── workflows/
│   │   ├── pylint.yml
│   │   ├── jslint.yml
│   │   └── review.yml
│   └── PULL_REQUEST_TEMPLATE.md
├── .pre-commit-config.yaml
├── commitlint.config.js
├── ruff.toml
└── README.md

MIT

This application is actively maintained by Ambibuzz Technologies LLP. For any issues, please raise a GitHub issue or contact us.

• GitHub: Ambibuzz
• Website: ambibuzz.com
• Email: buzz.us@ambibuzz.com