Skip to content

Latest commit

 

History

History
105 lines (68 loc) · 2.18 KB

CONTRIBUTING.md

File metadata and controls

105 lines (68 loc) · 2.18 KB

Contributing to <PACKAGE_NAME>

Thank you for your interest in contributing to <PACKAGE_NAME> 💙
Contributions of all kinds are welcome: bug fixes, improvements, documentation, and discussions.

Project Philosophy

This package follows these principles:

  • Be reusable across multiple NestJS applications
  • Expose a clear and stable public API
  • Keep domain logic isolated and testable
  • Avoid unnecessary framework or vendor lock-in
  • Favor correctness, safety, and clarity over shortcuts

Please keep these principles in mind when contributing.

Getting Started

1. Clone & Install

Clone the repository created from this template, then:

npm install

Branch Naming

Use descriptive branch names: • feat/ • fix/ • docs/ • refactor/

Examples:

• feat/add-new-provider • fix/congig-validation • docs/update-readme

Development Guidelines

• All code must be written in TypeScript • Public APIs must remain backward-compatible unless explicitly discussed • Prefer small, focused changes over large refactors • Avoid committing secrets, API keys, or credentials

Test & Quality

Before pushing or opening a PR, ensure the following pass:

npm run lint
npm run typecheck
npm test
npm run build

If you add or modify logic:

• Add unit tests for behaviour changes. • Avoid live external API calls in tests.

Pull Requests

When opening a PR:

• Clearly describe what was changed and why • Keep PRs focused on a single concern • Reference related issues if applicable • Update docummentation if APIs or behaviour change

A maintainer may ask for changes or clarification before merging.

What not to submit

• Breaking changes without prior discussion • Large refactors unrelated to the issue being solved • Experimental features without a clear use case • Code copied from proprietary or incompatible licenses

Questions or Ideas ?

If you’re unsure about a change or want to discuss an idea: • Open a GitHub Issue • Or start a GitHub Discussion

We’re happy to talk things through before you write code.