Contributing to ngx-debug-console

First off, thanks for taking the time to contribute! 🎉

Getting Started

1. Fork the repo: https://github.com/andrerds/ngx-debug-console
2. Clone your fork:

   git clone git@github.com:YOUR_USERNAME/ngx-debug-console.git
   cd ngx-debug-console
   

3. Install dependencies:

   npm install
   

4. Build the lib:

   npm run build
   

Development Workflow

Project Structure

src/
└── lib/
    ├── types.ts                    # LogEntry, LogLevel, DebugConsoleConfig
    ├── debug-console.service.ts    # Console interception + log store
    ├── debug-http.interceptor.ts   # HTTP auto-capture
    ├── provide-debug-console.ts    # provideDebugConsole() function
    ├── debug-console.component.ts  # Main component
    ├── debug-console.component.html
    ├── debug-console.component.css
    └── debug-console.module.ts     # NgModule wrapper

Testing locally with npm link

# Inside ngx-debug-console/
npm run build
cd dist
npm link

# Inside your Angular project
npm link ngx-debug-console

How to Contribute

Reporting Bugs

Open an issue at https://github.com/andrerds/ngx-debug-console/issues with:

• Angular version
• Steps to reproduce
• Expected vs actual behavior
• Screenshots if applicable

Suggesting Features

Open an issue with the enhancement label. Describe:

• The use case
• Why it would benefit other users
• Any implementation ideas

Submitting a Pull Request

1. Create a branch from main:

   git checkout -b feat/my-feature
   # or
   git checkout -b fix/my-bugfix
   

2. Make your changes following the code style (see below)
3. Commit using Conventional Commits:

   feat: add dark/light theme toggle
   fix: prevent duplicate log entries on hot reload
   docs: update README usage examples
   chore: bump ng-packagr to 14.2
   

4. Push and open a PR against main
5. Fill in the PR template

Code Style

• TypeScript strict mode
• BEM naming for CSS classes (prefix ndc-)
• No external UI dependencies (no Ionic, no Material)
• Keep the lib tree-shakeable — avoid side effects at module level
• Add JSDoc to all public methods and interfaces

Commit Convention

Prefix	When to use
feat	New feature
fix	Bug fix
docs	Documentation only
style	Formatting, no logic change
refactor	Code change that's neither fix nor feature
test	Adding or fixing tests
chore	Build process, dependencies

Questions?

Open a discussion at https://github.com/andrerds/ngx-debug-console/discussions