{"id":14956625,"url":"https://github.com/mongodb/specifications","last_synced_at":"2025-05-14T23:05:31.984Z","repository":{"id":16492211,"uuid":"19244865","full_name":"mongodb/specifications","owner":"mongodb","description":"Specifications related to MongoDB","archived":false,"fork":false,"pushed_at":"2025-05-12T18:17:33.000Z","size":18009,"stargazers_count":396,"open_issues_count":19,"forks_count":245,"subscribers_count":75,"default_branch":"master","last_synced_at":"2025-05-12T18:49:31.707Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://specifications.readthedocs.io/en/latest","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mongodb.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2014-04-28T16:04:56.000Z","updated_at":"2025-05-12T15:46:52.000Z","dependencies_parsed_at":"2024-01-09T17:47:56.376Z","dependency_job_id":"1b3f293e-6885-4a1c-967c-db2ae81337ce","html_url":"https://github.com/mongodb/specifications","commit_stats":{"total_commits":2415,"total_committers":111,"mean_commits":"21.756756756756758","dds":0.865424430641822,"last_synced_commit":"787bbe67bdffb614270654372112e93fc2cd3eb3"},"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mongodb%2Fspecifications","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mongodb%2Fspecifications/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mongodb%2Fspecifications/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mongodb%2Fspecifications/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mongodb","download_url":"https://codeload.github.com/mongodb/specifications/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254243358,"owners_count":22038046,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-09-24T13:13:14.703Z","updated_at":"2025-05-14T23:05:26.974Z","avatar_url":"https://github.com/mongodb.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"# MongoDB Specifications\n\n[![Documentation Status](https://readthedocs.org/projects/specifications/badge/?version=latest)](http://specifications.readthedocs.io/en/latest/?badge=latest)\n\nThis repository holds in progress and completed specification for features of MongoDB, Drivers, and associated products.\nAlso contained is a rudimentary system for producing these documents.\n\n## Driver Mantras\n\nSee [Documentation](./source/driver-mantras.md).\n\n## Writing Documents\n\nWrite documents using [GitHub Flavored Markdown](https://github.github.com/gfm/), following the\n[MongoDB Documentation Style Guidelines](https://www.mongodb.com/docs/meta/style-guide/).\n\nStore all source documents in the `source/` directory.\n\n## Linting\n\nThis repo uses [pre-commit](https://pypi.org/project/pre-commit/) for managing linting. `pre-commit` performs various\nchecks on the files and uses tools that help follow a consistent style within the repo.\n\nTo set up `pre-commit` locally, run:\n\n```bash\nbrew install pre-commit\npre-commit install\n```\n\nTo run `pre-commit` manually, run `pre-commit run --all-files`.\n\nTo run a manual hook like `shellcheck` manually, run:\n\n```bash\npre-commit run --all-files --hook-stage manual shellcheck\n```\n\n## Prose test numbering\n\nWhen numbering prose tests, always use relative numbered bullets (`1.`). New tests must be appended at the end of the\ntest list, since drivers may refer to existing tests by number.\n\nOutdated tests must not be removed completely, but may be marked as such (e.g. by striking through or replacing the\nentire test with a note (e.g. *Removed*).\n\n## Building Documents\n\nWe use [mkdocs](https://www.mkdocs.org/) to render the documentation. To see a live view of the documentation, in a\nPython [venv](https://docs.python.org/3/library/venv.html) run:\n\n```bash\npip install -r source/requirements.txt\nmkdocs serve\n```\n\nTo build the docs, use `mkdocs build`.\n\nIn CI we verify that there are no warnings. To replicate locally, run `mkdocs build --strict`.\n\n## Converting to JSON\n\nThere are many YAML to JSON converters. There are even several converters called `yaml2json` in NPM. Alas, we are not\nusing `yaml2json` anymore, but instead the [js-yaml](https://www.npmjs.com/package/js-yaml) package. Use only that\nconverter, so that JSON is formatted consistently.\n\nRun `npm install -g js-yaml`, then run `make` in the `source` directory at the top level of this repository to convert\nall YAML test files to JSON.\n\n## Licensing\n\nAll the specs in this repository are available under the\n[Creative Commons Attribution-NonCommercial-ShareAlike 3.0 United States License](https://creativecommons.org/licenses/by-nc-sa/3.0/us/).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmongodb%2Fspecifications","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmongodb%2Fspecifications","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmongodb%2Fspecifications/lists"}