CONTRIBUTING.md

Contributing to mongo-error-codes

Thank you for your interest in contributing to mongo-error-codes! This document provides guidelines and instructions for contributing.

Getting Started

1. Fork the Repository
   Fork the mongo-error-codes repository to your GitHub account.

2. Clone Your Fork

   git clone https://github.com/dmltdev/mongo-error-codes.git
   cd mongo-error-codes

3. Install Dependencies

   npm install

4. Build the Project

   npm run build

Development

• Branch Naming
  Create a new branch for your feature or bugfix:

  git checkout -b feature/your-feature-name

• Code Style
  Ensure your code follows the project's style guidelines defined in biome.json.

• Testing
  Run tests to ensure your changes work as expected:

  npm test

Submitting a Pull Request

1. Push Your Changes

   git push origin feature/your-feature-name

2. Create a Pull Request
   Go to the mongo-error-codes repository and create a pull request from your fork.

3. Describe Your Changes
   Provide a clear description of your changes and why they are needed.

4. Wait for Review
   Your PR will be reviewed by maintainers. Be ready to make changes if requested.

Additional Guidelines

• Commit Messages
  Use clear, descriptive commit messages.

• Documentation
  Update documentation (e.g., README, API docs) if your changes affect the public API.

• License
  By contributing, you agree that your contributions will be licensed under the project's MIT License.

---

Thank you for contributing!