Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
34 lines (24 loc) · 1.15 KB

CONTRIBUTING.md

File metadata and controls

34 lines (24 loc) · 1.15 KB

Contributing

Thanks for your interest in contributing to the Lucid MongoDB adapter for AdonisJS 6! This document contains guidelines for contributing to the project.

Development Setup

  1. Fork and clone the repository
  2. Install dependencies: npm install
  3. Run tests: npm test

Pull Request Guidelines

  • Make sure your code follows the style guide of the project
  • Make sure all tests pass
  • Add tests for new features
  • Update documentation if necessary
  • Rebase your branch before submitting a pull request

Commit Message Guidelines

We follow the Conventional Commits specification for our commit messages:

  • feat: A new feature
  • fix: A bug fix
  • docs: Documentation only changes
  • style: Changes that do not affect the meaning of the code
  • refactor: A code change that neither fixes a bug nor adds a feature
  • perf: A code change that improves performance
  • test: Adding missing tests or correcting existing tests
  • chore: Changes to the build process or auxiliary tools and libraries

License

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