{"_id":"@mapbox/teamrepo","_rev":"131-f1109c5bf0ce9cf350dd6def8a0f6cf5","name":"@mapbox/teamrepo","description":"Tests for Mapbox engineering team Github repos","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@mapbox/teamrepo","version":"1.0.0","description":"Tests for Mapbox engineering team Github repos","repository":{"type":"git","url":"https://github.com/mapbox/teamrepo/"},"author":{"name":"Mapbox"},"license":"ISC","bin":{"teamrepo":"./cli.js"},"scripts":{"lint":"eslint *.js test/*.js","test":"tape test/*.test.js"},"dependencies":{"ignore":"^3.3.7","tape":"^4.8.0"},"devDependencies":{"eslint":"^4.12.1","eslint-plugin-node":"^5.2.1"},"gitHead":"58ca62c7e41199aed6cb95a9a578bd812f69b802","_id":"@mapbox/teamrepo@1.0.0","_shasum":"cb70f28ff93e395058cc11354363da1a68b2943f","_from":".","_npmVersion":"3.10.10","_nodeVersion":"6.11.3","_npmUser":{"name":"vakila","email":"anjana.vakil@mapbox.com"},"dist":{"shasum":"cb70f28ff93e395058cc11354363da1a68b2943f","tarball":"https://registry.npmjs.org/@mapbox/teamrepo/-/teamrepo-1.0.0.tgz","integrity":"sha512-JPwNQaEAd9+QpZJAdQkFKvNdCZxFGdeU5qN2p4Ih2ohNSJ4W+pDB/yboOvwJ6qyKENqaIC/2JBa9x8/Vojo7ng==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCqk95ZBFnRjRxK8tZdC23cApEm/ty8q7HNtqrtzsnvUwIhAMAYVOiyPAXVNhTBx2S3ICF20r/Jb4UvPiPic35M3f6d"}]},"maintainers":[{"name":"vakila","email":"anjana.vakil@mapbox.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/teamrepo-1.0.0.tgz_1512747140895_0.31177883478812873"},"directories":{}}},"readme":"\n# teamrepo\n\nA test suite for team systems documentation\n\n## Goal\n\nDefine a consistent interface for engineering teams' internal documentation. Each team should have a repo and there should be a predictable layout and baseline set of content in each repo.\n\nThis should make it easier for new team members & members of other teams to discover basic information such as team charter, repo ownership, and onboarding materials.\n\n## Who is this for?\n- Managers & team members: makes it easy to keep your team repo consistent with other teams\n- Eng ops: gives us a path forward for iterating on/rolling out changes across teams and capturing it in code rather than via people-nagging\n\n\n## Team repo spec\n\nThe `teamrepo` tests ensure that a repo follows this basic structure:\n\n- `readme.md`: top-level documentation, includes a `## Contents` section to hold table of contents (ToC)\n- `charter.md`: team charter\n- `onboarding/`\n  - `readme.md`: includes high-level description and ToC of onboarding files/subdirectories\n  - onboarding materials (e.g. tutorials, reading lists) organized as needed\n- `hiring/`\n  - `readme.md`: includes high-level description and ToC of hiring files/subdirectories\n  - recruiting materials (e.g. homework assignments, interview questions) organized as needed\n\nIn any subdirectory in the repo, there must be a `readme.md` with a ToC that links to all the files/directories contained within.\n\n\n\n## Installation & Usage\n\n### Command line tool\nThe `teamrepo` tool can be used to run the tests against a local repo directory.\n\n    $ git clone git@github.com:mapbox/teamrepo.git\n    Cloning into 'teamrepo'...\n    $ npm install -g teamrepo/\n    $ teamrepo geocoding/\n    TAP version 13\n    # geocoding team charter\n    ok 1 geocoding/charter.md should exist and not be empty\n    ...\n\n\n### Ignoring files/subdirectories\nDirectories and files whose names start with `.`, e.g. `.git`, are ignored by default (using the ignore module). If you wish to ignore or unignore specific files, include a file named `.teamrepoignore` in the root of your repo with a newline-separated list of the file patterns to (un)ignore, e.g.:\n\n```\n# patterns to ignore\nignoreme.md\n**/ignoremeanywhere.md\nignorethisdir\n\n# patterns to unignore\n!.dontignoreme\n```\n","maintainers":[{"email":"yannick.meeus+npm+production+ci@mapbox.com","name":"mbx-npm-ci-production"},{"email":"yannick.meeus+npm+staging+ci@mapbox.com","name":"mbx-npm-ci-staging"},{"email":"yannick.meeus+npm+prod+advanced+actions@mapbox.com","name":"mbx-npm-advanced-actions-production"},{"email":"yannick.meeus+npm+staging+advanced+actions@mapbox.com","name":"mbx-npm-advanced-actions-staging"},{"email":"yannick.meeus+npm+prod+09@mapbox.com","name":"mbx-npm-09-production"},{"email":"yannick.meeus+npm+prod+08@mapbox.com","name":"mbx-npm-08-production"},{"email":"yannick.meeus+npm+prod+07@mapbox.com","name":"mbx-npm-07-production"},{"email":"yannick.meeus+npm+prod+06@mapbox.com","name":"mbx-npm-06-production"},{"email":"yannick.meeus+npm+prod+05@mapbox.com","name":"mbx-npm-05-production"},{"email":"yannick.meeus+npm+prod+04@mapbox.com","name":"mbx-npm-04-production"},{"email":"yannick.meeus+npm+prod+03@mapbox.com","name":"mbx-npm-03-production"},{"email":"yannick.meeus+npm+prod+02@mapbox.com","name":"mbx-npm-02-production"},{"email":"yannick.meeus+npm+prod+01@mapbox.com","name":"mbx-npm-01-production"},{"email":"yannick.meeus@mapbox.com","name":"mbx-npm-02-staging"},{"email":"accounts+npmjs-01@mapbox.com","name":"mapbox-npm-01"},{"email":"accounts+npmjs-02@mapbox.com","name":"mapbox-npm-02"},{"email":"accounts+npmjs-07@mapbox.com","name":"mapbox-npm-07"},{"email":"accounts+npmjs-03@mapbox.com","name":"mapbox-npm-03"},{"email":"accounts+npmjs-04@mapbox.com","name":"mapbox-npm-04"},{"email":"accounts+npmjs-09@mapbox.com","name":"mapbox-npm-09"},{"email":"accounts+npmjs-05@mapbox.com","name":"mapbox-npm-05"},{"email":"accounts+npmjs-06@mapbox.com","name":"mapbox-npm-06"},{"email":"accounts+npmjs-08@mapbox.com","name":"mapbox-npm-08"},{"email":"accounts+npmjs-advanced-actions@mapbox.com","name":"mapbox-npm-advanced-actions"},{"email":"accounts+npmjs-npm-ci@mapbox.com","name":"mapbox-npm-ci"},{"email":"accounts+npmjs@mapbox.com","name":"mapbox-npm"},{"email":"accounts@mapbox.com","name":"mapbox-admin"},{"email":"accounts+npm-mapbox-machine-user@mapbox.com","name":"mapbox-machine-user"}],"time":{"modified":"2023-01-12T12:45:35.098Z","created":"2017-12-08T15:32:21.841Z","1.0.0":"2017-12-08T15:32:21.841Z"},"repository":{"type":"git","url":"https://github.com/mapbox/teamrepo/"},"author":{"name":"Mapbox"},"license":"ISC","readmeFilename":"README.md"}