Skip to content

Commit d61aa62

Browse files
Priyanshu RajPriyanshu Raj
authored andcommitted
feat: upgrade repository to industrial-grade with Prettier, EditorConfig, security policies, and documentation refinements
1 parent 997919f commit d61aa62

17 files changed

Lines changed: 451 additions & 196 deletions

.editorconfig

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# EditorConfig helps developers define and maintain consistent coding styles between different editors and IDEs.
2+
# https://editorconfig.org
3+
4+
root = true
5+
6+
[*]
7+
indent_style = space
8+
indent_size = 2
9+
end_of_line = lf
10+
charset = utf-8
11+
trim_trailing_whitespace = true
12+
insert_final_newline = true
13+
14+
[*.md]
15+
trim_trailing_whitespace = false

.github/CODEOWNERS

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# CODEOWNERS
2+
# Automatically assigns reviewers and enforces approval rules for pull requests.
3+
# Learn more: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners
4+
5+
# Default owners for all files in the repository
6+
* @acadify-solution/engineering-leads
7+
8+
# Owners for core standards documents
9+
/standards/ @acadify-solution/engineering-leads @acadify-solution/security-leads
10+
11+
# Owners for CI/CD workflows and repository configs
12+
/.github/ @acadify-solution/devops-leads
13+
/.husky/ @acadify-solution/devops-leads
14+
package.json @acadify-solution/devops-leads
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
name: 🐛 Bug Report
3+
about: Report a bug or issue in a codebase or workflow setup.
4+
title: 'bug: [Short description]'
5+
labels: bug, triage
6+
assignees: ''
7+
---
8+
9+
## Description
10+
11+
Provide a clear and concise description of what the bug is.
12+
13+
## Steps to Reproduce
14+
15+
Steps to reproduce the behavior:
16+
17+
1. Go to '...'
18+
2. Run command '...'
19+
3. See error output '...'
20+
21+
## Expected Behavior
22+
23+
A clear description of what you expected to happen.
24+
25+
## Environment & Versions
26+
27+
- **Operating System:** [e.g., macOS Sequoia, Ubuntu 22.04]
28+
- **Language / Runtime Version:** [e.g., Node.js v20.11.0, Python 3.11.6]
29+
- **Framework Version:** [e.g., FastAPI 0.109.0, Next.js 14.1.0]
30+
31+
## Additional Context / Logs
32+
33+
Attach any terminal logs, screenshots, or stack traces here.
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
name: 🚀 Feature Request
3+
about: Propose a new capability or architectural enhancement.
4+
title: 'feat: [Short description]'
5+
labels: enhancement, discussion
6+
assignees: ''
7+
---
8+
9+
## Problem Statement
10+
11+
Is your feature request related to a problem? Please describe. (e.g., "It's difficult to verify model gateways because...")
12+
13+
## Proposed Solution
14+
15+
A clear description of what you want to happen. Explain the proposed code modifications or architecture changes.
16+
17+
## Technical Justification
18+
19+
How does this change align with Acadify's high-reliability AI, SaaS, or infrastructure goals? Note any performance or security implications.
20+
21+
## Alternatives Considered
22+
23+
Describe any alternative solutions or workarounds you've considered.
24+
25+
## Implementation Details (Optional)
26+
27+
If you have mock code snippets, API interfaces, or database design draft ideas, share them here.
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
name: 📝 Standards Amendment / Proposal
3+
about: Propose a change, addition, or refinement to Acadify's engineering standards.
4+
title: 'proposal: [Short description of standard change]'
5+
labels: standards, discussion
6+
assignees: ''
7+
---
8+
9+
## Proposed Amendment
10+
11+
Which document and section does this affect?
12+
13+
- [ ] README.md
14+
- [ ] standards/branching-git.md
15+
- [ ] standards/coding-practices.md
16+
- [ ] standards/peer-reviews.md
17+
- [ ] standards/release-management.md
18+
- [ ] New standards file (describe below)
19+
20+
## Detailed Description
21+
22+
Please detail the modification or new standard policy you are proposing.
23+
24+
## Rationale & Industry Alignment
25+
26+
Why should Acadify adopt this standard? How does this protect our systems or enhance our developer velocity? Reference any standard patterns, compliance baselines (SOC2, HIPAA), or industry articles if applicable.
27+
28+
## Mock Content / Draft Text
29+
30+
Provide a draft of the proposed markdown text as you would like it to appear in the documents.

.github/pull_request_template.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,21 +26,25 @@ Please provide a clear and concise description of the changes proposed in this P
2626
Please verify that each of the following requirements is completed before marking this PR as ready for review:
2727

2828
### 1. Code Quality & Formatting
29+
2930
- [ ] Code compiles and builds locally without errors or warnings.
3031
- [ ] Code styles adhere to the language-specific formatting standard (Prettier, Black, Go fmt).
3132
- [ ] No temporary debug logs, print statements, or commented-out code blocks are left in.
3233

3334
### 2. Testing & Verification
35+
3436
- [ ] Unit tests written and passing for all modified logic (FastAPI, Go, PyTorch).
3537
- [ ] Integration or E2E tests run successfully (Playwright, regression suites).
3638
- [ ] Test coverage meets the team threshold (minimum 80% coverage on new code).
3739

3840
### 3. Compliance & Security by Design
41+
3942
- [ ] **PII Masking:** Verified that personal data (PII) is sanitized before transit to LLMs or external logging.
4043
- [ ] **Security Scans:** Local dependency vulnerability scanning run and verified clean (e.g., `npm audit`, `safety check`).
4144
- [ ] **HIPAA/SOC2:** Audited modifications against least-privilege policies, secure database queries, and log auditing.
4245

4346
### 4. Release Readiness
47+
4448
- [ ] Release checklist followed (see [release-management.md](file:///Users/acadify/Desktop/engineering%20standards/standards/release-management.md)).
4549
- [ ] SemVer impact identified: [Major / Minor / Patch].
4650
- [ ] Changelog draft or release notes draft included below (if applicable).
@@ -52,6 +56,7 @@ Please verify that each of the following requirements is completed before markin
5256
Provide outputs, command logs, or screenshots confirming that the changes have been verified. For UI changes, please attach screenshots or screen recordings showing the UI behavior in different viewports.
5357

5458
### Local Test Output Snippet
59+
5560
```bash
5661
# Paste test run results here
5762
```

.husky/pre-commit

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
npx markdownlint "**/*.md" --ignore node_modules
1+
npm run lint

.prettierignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
node_modules/
2+
package-lock.json
3+
.husky/

.prettierrc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"singleQuote": true,
3+
"tabWidth": 2,
4+
"trailingComma": "es5",
5+
"printWidth": 120,
6+
"proseWrap": "preserve"
7+
}

README.md

Lines changed: 45 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,85 +1,90 @@
11
# Acadify Solution — Engineering Standards & Practices
22

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.
44

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.
66

77
---
88

99
## 🗺️ Standards Navigation
1010

11-
Our development practices are structured into four main areas:
11+
Our core engineering guidelines are divided into four primary domains:
1212

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. |
1919

2020
---
2121

22-
## 🛠️ Automated Quality & Tooling
22+
## 🛠️ Onboarding & Local Setup
2323

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.
2525

26-
### Local Environment Setup
26+
### Development Environment Setup
2727

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:
2929

30-
#### Prerequisites
30+
#### 1. Prerequisites
3131

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:
3433

35-
#### Step 1: Install Dependencies
34+
- Node.js (LTS v20+)
35+
- npm (pre-packaged with Node.js) or `pnpm`
3636

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):
3840

3941
```bash
4042
npm install
4143
```
4244

43-
#### Step 2: Enable Git Hooks (Husky)
45+
#### 3. IDE Integration (Recommended)
4446

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:
4648

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+
---
5053

51-
### Formatting and Linting Checks
54+
## 🤖 Validation Pipelines
5255

53-
#### Manual Check
56+
We run three validation layers to prevent formatting discrepancies or broken documentation structures from entering production:
5457

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:
5665

5766
```bash
58-
# Run lint check
67+
# Run syntax and formatting verification manually
5968
npm run lint
6069

61-
# Auto-fix fixable markdown format issues
70+
# Auto-correct formatting and fixable markdown structure issues
6271
npm run lint:fix
6372
```
6473

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)
7075

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.
7277

7378
---
7479

75-
## 🤝 Contribution Guidelines
80+
## 📝 Amending the Standards
7681

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:
7883

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.
8287

8388
---
8489

85-
© 2026 Acadify Solution. All rights reserved. Distributed engineering partner.
90+
© 2026 Acadify Solution. All rights reserved. Globally distributed team.

0 commit comments

Comments
 (0)