Skip to main content
We welcome contributions to Node Blueprint! Whether you’re fixing bugs, adding features, or improving documentation, your help is appreciated.

​
Before You Start

Before diving into code, please follow these important guidelines:
1

Open an issue first

Always discuss your proposed changes by opening an issue before writing code. This helps:
  • Avoid duplicate work
  • Ensure your contribution aligns with project goals
  • Get early feedback on your approach
2

Check existing issues

Search through open and closed issues to make sure someone else isn’t already working on the same feature or bug fix.
3

Fork the repository

Create your own fork and feature branch from the main branch:
git clone https://github.com/YOUR_USERNAME/node-blueprint.git
git checkout -b feature/your-feature-name

​
Golden Rule

Always test template generation with multiple combinations before submitting your PR!Test different combinations of frameworks, databases, and ORMs to ensure your changes work across all possible configurations.

​
What Can You Contribute?

​
Bug Fixes

Found a bug? Great! Open an issue describing the problem, then submit a PR with your fix.

​
New Features

Want to add a new feature? Discuss it in an issue first to get community feedback.

​
New Templates

Adding support for new frameworks, databases, or ORMs? See the Adding Templates guide.

​
Documentation

Improving documentation is always welcome! Fix typos, add examples, or clarify confusing sections.

​
Contribution Workflow

  1. Fork & Clone - Fork the repository and clone it locally
  2. Create Branch - Create a feature branch for your changes
  3. Make Changes - Implement your changes with clear, well-documented code
  4. Test - Test your changes thoroughly with multiple configurations
  5. Commit - Write clear, descriptive commit messages
  6. Push - Push your changes to your fork
  7. Pull Request - Open a PR with a detailed description of your changes

​
Code Standards

  • Follow the existing code style and conventions
  • Write TypeScript with proper type definitions
  • Keep functions small and focused
  • Add comments for complex logic
  • Use ESM imports/exports consistently

​
Getting Help

Stuck? Have questions? Feel free to:
  • Ask in the issue you created
  • Join discussions in existing issues
  • Reach out to maintainers

​
Next Steps

Local Setup

Set up your development environment

Monorepo Structure

Understand the codebase organization

Adding Templates

Learn how to add new templates

Build docs developers (and LLMs) love

Get started for freeTalk to us