Skip to content

Latest commit

 

History

History
79 lines (51 loc) · 1.64 KB

CONTRIBUTING.md

File metadata and controls

79 lines (51 loc) · 1.64 KB
Raw

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

By contributing to, you agree to abide by the code of conduct.

Reporting issues

Before opening an issue, please search the issue tracker to make sure your issue hasn't already been reported.

Development

Fork, then clone the repo:

git clone https://github.com/your-username/mongo-dot-notation.git

Install dependencies:

npm install

Building

Running the build tasks builds TypeScript:

npm run build

Linting

This repository uses prettier for code formatting. To format code:

npm run prettier:fix

To perform linting:

npm run lint

Testing

To run unit tests:

npm run test

To calculate code coverage:

npm run test:coverage

You can run end to end tests if you have docker and docker-compose installed:

npm run test:e2e:docker

Submitting changes

  • Open a new issue in the Issue tracker.
  • Fork the repo.
  • Create a new feature branch based off the main branch.
  • Make sure all tests pass and there are no linting errors.
    • For new features, make sure to cover the code with tests
    • For issues, please add a test case that covers it
  • Submit a pull request, referencing any issues it addresses.

Please try to keep your pull request focused in scope and avoid including unrelated commits.

Thank you!