|
1 | 1 | # Acadify Solution — Engineering Standards & Practices |
2 | 2 |
|
3 | | -Welcome to the **Acadify Solution Engineering Standards** repository. This centralized resource defines our internal engineering policies, code quality guidelines, and compliance requirements. |
| 3 | +This repository serves as the definitive reference for engineering standards, development workflows, and compliance baselines at Acadify Solution. |
4 | 4 |
|
5 | | -As a distributed team of senior developers building high-reliability AI systems, secure cloud architectures, and scalable SaaS platforms, we hold ourselves to rigorous development standards. Adhering to these guidelines ensures our code is secure, scalable, maintainable, and aligned with industry compliance standards (including HIPAA and SOC2). |
| 5 | +As a distributed team of senior developers building high-reliability AI products, scalable SaaS platforms, and secure cloud infrastructure, we hold our codebases to rigorous production-grade standards. Consistent execution of these practices ensures security, maintainability, and alignment with critical HIPAA and SOC2 compliance targets. |
6 | 6 |
|
7 | 7 | --- |
8 | 8 |
|
9 | 9 | ## 🗺️ Standards Navigation |
10 | 10 |
|
11 | | -Our development practices are structured into four main areas: |
| 11 | +Our core engineering guidelines are divided into four primary domains: |
12 | 12 |
|
13 | | -| Standards Document | Key Topics Covered | |
14 | | -| :--- | :--- | |
15 | | -| 🌿 **[Branching & Git Guidelines](standards/branching-git.md)** | Branching models (Trunk-Based / Git Flow), Branch Protection policies, and Conventional Commits. | |
16 | | -| 🛡️ **[Coding & Security Practices](standards/coding-practices.md)** | AI/LLM safety, PII Masking, HIPAA/SOC2 design rules, SaaS patterns, and static analysis benchmarks. | |
17 | | -| 👥 **[Peer Reviews & PR Guidelines](standards/peer-reviews.md)** | PR criteria, Author self-audits, Reviewer responsibilities, and PR templates. | |
18 | | -| 🚀 **[Release & Versioning](standards/release-management.md)** | Semantic Versioning (SemVer), release checklists, changelog management, and hotfix paths. | |
| 13 | +| Standard Guide | Core Subjects | |
| 14 | +| :------------------------------------------------------------------ | :---------------------------------------------------------------------------- | |
| 15 | +| 🌿 **[Branching & Git Guidelines](standards/branching-git.md)** | Branching topologies, PR size constraints, and Conventional Commits. | |
| 16 | +| 🛡️ **[Coding & Security Practices](standards/coding-practices.md)** | PII masking filters, HIPAA/SOC2 design rules, and framework architectures. | |
| 17 | +| 👥 **[Peer Reviews & PR Guidelines](standards/peer-reviews.md)** | Self-review benchmarks, reviewer responsibilities, and PR templates. | |
| 18 | +| 🚀 **[Release & Versioning](standards/release-management.md)** | SemVer 2.0.0 compliance, deployment vs. release separation, and hotfix paths. | |
19 | 19 |
|
20 | 20 | --- |
21 | 21 |
|
22 | | -## 🛠️ Automated Quality & Tooling |
| 22 | +## 🛠️ Onboarding & Local Setup |
23 | 23 |
|
24 | | -To minimize manual overhead and maintain a consistent baseline, we enforce automatic linting and code styles across all repositories via git hooks and CI checkups. |
| 24 | +Every repository at Acadify Solution enforces formatting and linting rules locally using Git hooks and in CI workflows using GitHub Actions. |
25 | 25 |
|
26 | | -### Local Environment Setup |
| 26 | +### Development Environment Setup |
27 | 27 |
|
28 | | -When you clone any Acadify repository (including this standards repo), follow these steps to initialize the automated quality tools: |
| 28 | +To configure your local environment for automated style enforcement: |
29 | 29 |
|
30 | | -#### Prerequisites |
| 30 | +#### 1. Prerequisites |
31 | 31 |
|
32 | | -* Node.js (LTS version 20+) |
33 | | -* pnpm / npm / yarn (We recommend `npm` or `pnpm` depending on repository configurations) |
| 32 | +Ensure you have the following installed on your development machine: |
34 | 33 |
|
35 | | -#### Step 1: Install Dependencies |
| 34 | +- Node.js (LTS v20+) |
| 35 | +- npm (pre-packaged with Node.js) or `pnpm` |
36 | 36 |
|
37 | | -This project uses DevDependencies to lint documentation files using `markdownlint-cli` and manage git hooks using `husky`. |
| 37 | +#### 2. Install Development Dependencies |
| 38 | + |
| 39 | +Clone this repository and install the development packages (Prettier for formatting, Markdownlint for structure checking, and Husky for hook automation): |
38 | 40 |
|
39 | 41 | ```bash |
40 | 42 | npm install |
41 | 43 | ``` |
42 | 44 |
|
43 | | -#### Step 2: Enable Git Hooks (Husky) |
| 45 | +#### 3. IDE Integration (Recommended) |
44 | 46 |
|
45 | | -Husky will automatically configure hook directories based on the `"prepare"` script in `package.json`. If it does not run, you can initialize it manually: |
| 47 | +This repository contains a `.editorconfig` file that automatically configures text formatting rules (spaces vs. tabs, indentation depth, line endings) for your editor. We recommend installing the corresponding plugin if your IDE does not support EditorConfig natively: |
46 | 48 |
|
47 | | -```bash |
48 | | -npx husky |
49 | | -``` |
| 49 | +- **VS Code:** Install the `EditorConfig for VS Code` and `Prettier - Code formatter` extensions. |
| 50 | +- **JetBrains (IntelliJ/WebStorm):** EditorConfig support is enabled out-of-the-box. |
| 51 | + |
| 52 | +--- |
50 | 53 |
|
51 | | -### Formatting and Linting Checks |
| 54 | +## 🤖 Validation Pipelines |
52 | 55 |
|
53 | | -#### Manual Check |
| 56 | +We run three validation layers to prevent formatting discrepancies or broken documentation structures from entering production: |
54 | 57 |
|
55 | | -You can run the markdown lint checks on demand: |
| 58 | +### 1. Editor Formatting |
| 59 | + |
| 60 | +Rules configured in `.editorconfig` and `.prettierrc` format your files automatically on save. |
| 61 | + |
| 62 | +### 2. Pre-Commit Verification (Husky) |
| 63 | + |
| 64 | +A local pre-commit hook runs `npm run lint` on staged files before allowing commits: |
56 | 65 |
|
57 | 66 | ```bash |
58 | | -# Run lint check |
| 67 | +# Run syntax and formatting verification manually |
59 | 68 | npm run lint |
60 | 69 |
|
61 | | -# Auto-fix fixable markdown format issues |
| 70 | +# Auto-correct formatting and fixable markdown structure issues |
62 | 71 | npm run lint:fix |
63 | 72 | ``` |
64 | 73 |
|
65 | | -#### Commit-time Hooks |
66 | | - |
67 | | -Husky prevents malformed documentation commits by automatically running `markdownlint` before your commit goes through. If linting fails, resolve the errors indicated in the command-line output and re-run your `git commit` command. |
68 | | - |
69 | | -#### Continuous Integration (CI) |
| 74 | +### 3. Continuous Integration (GitHub Actions) |
70 | 75 |
|
71 | | -A GitHub Actions workflow (`.github/workflows/lint.yml`) runs on every pull request targeting `main`. PRs cannot be merged if the linting checks fail. |
| 76 | +The workflow in `.github/workflows/lint.yml` executes formatting and syntax checks on all pull requests targeting the `main` branch. PR merges are blocked until all checks pass. |
72 | 77 |
|
73 | 78 | --- |
74 | 79 |
|
75 | | -## 🤝 Contribution Guidelines |
| 80 | +## 📝 Amending the Standards |
76 | 81 |
|
77 | | -We treat our standards as living documentation. If you spot a gap, outdated practice, or have an optimization proposal: |
| 82 | +We maintain our standards as living documentation. To propose updates or refinements: |
78 | 83 |
|
79 | | -1. Create a branch named `refactor/standards-update-<topic>`. |
80 | | -2. Propose the standard updates and verify they comply with the markdown linting rules. |
81 | | -3. Open a Pull Request and assign it to the engineering leads for review. |
| 84 | +1. Review the [Security Policy](SECURITY.md) to ensure no internal security procedures are leaked. |
| 85 | +2. Open an issue using the [Standards Amendment Template](.github/ISSUE_TEMPLATE/standards_proposal.md). |
| 86 | +3. Following consensus, create a branch named `refactor/standards-update-<topic>` and submit a Pull Request. |
82 | 87 |
|
83 | 88 | --- |
84 | 89 |
|
85 | | -© 2026 Acadify Solution. All rights reserved. Distributed engineering partner. |
| 90 | +© 2026 Acadify Solution. All rights reserved. Globally distributed team. |
0 commit comments