58 lines (40 loc) · 1.7 KB

Contributing to @cryxto/ioc-n-di

Thank you for your interest in contributing to our project! This guide will help you get started with the development process.

Development Setup

Prerequisites

Bun installed on your system

Getting Started

Fork the repository
Clone your fork: git clone https://github.com/Cryxto/ioc-n-di.git
Navigate to the project directory: cd ioc-n-di
Install dependencies: bun install
Start development: bun run dev

Development Workflow

Create a new branch: git checkout -b feature/your-feature-name
Make your changes
Check and fix code style and formatting issues: bun run lint:fix
Run tests: bun run test
Build the project: bun run build
Commit your changes using the conventions below
Push your branch to your fork
Open a pull request

Commit Message Conventions

We follow Conventional Commits for clear and structured commit messages:

feat: New features
fix: Bug fixes
docs: Documentation changes
style: Code style changes (formatting, etc.)
refactor: Code changes that neither fix bugs nor add features
perf: Performance improvements
test: Adding or updating tests
chore: Maintenance tasks, dependencies, etc.

Pull Request Guidelines

Update documentation if needed
Ensure all tests pass
Address any feedback from code reviews
Once approved, your PR will be merged

Code of Conduct

Please be respectful and constructive in all interactions within our community.

Questions?

If you have any questions, please open an issue for discussion.

Thank you for contributing to @cryxto/ioc-n-di!