Page Not Found
We could not find what you were looking for.
Please contact the owner of the site that linked you to the original URL and let them know their link is broken.
We could not find what you were looking for.
Please contact the owner of the site that linked you to the original URL and let them know their link is broken.
npm Usage",id:"-npm-usage",level:2},{value:"\ud83d\udd27 Configuration",id:"-configuration",level:2},{value:"npm",id:"npm",level:3},{value:"GitHub Actions",id:"github-actions",level:3},{value:"Docker",id:"docker",level:3},{value:"Environment Variables",id:"environment-variables",level:3},{value:"Workflow Examples",id:"workflow-examples",level:2},{value:"Node Application",id:"node-application",level:3},{value:"npm Library",id:"npm-library",level:3},{value:"Docker Image",id:"docker-image",level:3},{value:"Pre-Releases",id:"pre-releases",level:3},{value:"FAQs",id:"faqs",level:2},{value:"Which Assets are Pushed to Git?",id:"which-assets-are-pushed-to-git",level:3},{value:"What is the Commit Convention?",id:"what-is-the-commit-convention",level:3},{value:"How to Enrich the Static Distribution?",id:"how-to-enrich-the-static-distribution",level:3},{value:"How to Start Using Pre-Releases?",id:"how-to-start-using-pre-releases",level:3},{value:"Contributing",id:"contributing",level:2}];function d(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",li:"li",p:"p",pre:"pre",ul:"ul",...(0,i.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(n.h2,{id:"description",children:"Description"}),"\n",(0,a.jsxs)(n.p,{children:["The ",(0,a.jsx)(n.code,{children:"npm"})," package ",(0,a.jsx)(n.code,{children:"@open-sauced/semantic-release-conventional-config"})," is designed to help ",(0,a.jsx)(n.code,{children:"npm"})," packages auto-release to ",(0,a.jsx)(n.code,{children:"npm"})," or ",(0,a.jsx)(n.a,{href:"https://ghcr.io",children:(0,a.jsx)(n.code,{children:"ghcr"})})," registries while generating GitHub releases and changelog using conventional commit convention."]}),"\n",(0,a.jsx)(n.p,{children:"Version 2 supports alpha and beta pre-releases using corresponding branches."}),"\n",(0,a.jsx)(n.h2,{id:"dependencies",children:"Dependencies"}),"\n",(0,a.jsx)(n.p,{children:"This package uses the following modules:"}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.a,{href:"https://github.com/semantic-release/commit-analyzer",children:(0,a.jsx)(n.code,{children:"@semantic-release/commit-analyzer"})})}),"\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.a,{href:"https://github.com/semantic-release/release-notes-generator",children:(0,a.jsx)(n.code,{children:"@semantic-release/release-notes-generator"})})}),"\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.a,{href:"https://github.com/conventional-changelog/conventional-changelog",children:(0,a.jsx)(n.code,{children:"@conventional-changelog/conventional-changelog"})})}),"\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.a,{href:"https://github.com/semantic-release/changelog",children:(0,a.jsx)(n.code,{children:"@semantic-release/changelog"})})}),"\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.a,{href:"https://github.com/semantic-release/npm",children:(0,a.jsx)(n.code,{children:"@semantic-release/npm"})})}),"\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.a,{href:"https://github.com/google/semantic-release-replace-plugin",children:(0,a.jsx)(n.code,{children:"@google/semantic-release-replace-plugin"})})}),"\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.a,{href:"https://github.com/cbhq/semantic-release-license",children:(0,a.jsx)(n.code,{children:"@cbhq/semantic-release-license"})})}),"\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.a,{href:"https://github.com/semantic-release/git",children:(0,a.jsx)(n.code,{children:"@semantic-release/git"})})}),"\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.a,{href:"https://github.com/semantic-release/github",children:(0,a.jsx)(n.code,{children:"@semantic-release/github"})})}),"\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.a,{href:"https://github.com/eclass/semantic-release-docker",children:(0,a.jsx)(n.code,{children:"@eclass/semantic-release-docker"})})}),"\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.a,{href:"https://github.com/semantic-release/exec",children:(0,a.jsx)(n.code,{children:"@semantic-release/exec"})})}),"\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.a,{href:"https://github.com/sindresorhus/execa",children:(0,a.jsx)(n.code,{children:"execa"})})}),"\n"]}),"\n",(0,a.jsx)(n.h2,{id:"\ufe0f-requirements",children:"\ud83d\udda5\ufe0f Requirements"}),"\n",(0,a.jsx)(n.p,{children:"Most important limitations are:"}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.code,{children:"GITHUB_TOKEN"})," for everything"]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.code,{children:"NPM_TOKEN"})," for public ",(0,a.jsx)(n.code,{children:"npm"})," library"]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.code,{children:"docker"})," containers need to be built beforehand"]}),"\n"]}),"\n",(0,a.jsxs)(n.p,{children:["You can skip here if you are using an elevated ",(0,a.jsx)(n.a,{href:"https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token",children:"Private Access Token"}),". However, we don't recommend going down that path."]}),"\n",(0,a.jsx)(n.p,{children:"No force push or admin cherries branch protections for the following branches:"}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.code,{children:"main"})," - required"]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.code,{children:"alpha"})," - optional, pre-release branch"]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.code,{children:"beta"})," - optional, pre-release branch"]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.code,{children:"next"})," - optional, next channel"]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.code,{children:"next-major"})," - optional, next major"]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.code,{children:"vX[.X.X]"})," - maintenance releases"]}),"\n"]}),"\n",(0,a.jsxs)(n.p,{children:["If you use more than the ",(0,a.jsx)(n.code,{children:"main"})," branch, optionally create an environment that limits where pushes can come from and enable the merge strategy."]}),"\n",(0,a.jsxs)(n.p,{children:["We use ",(0,a.jsx)(n.code,{children:"production"})," in our examples; if you copy-paste them, you will find this new environment generated in your settings! \ud83c\udf55"]}),"\n",(0,a.jsx)(n.h2,{id:"-github-actions-usage",children:"\ud83e\uddea GitHub Actions Usage"}),"\n",(0,a.jsxs)(n.p,{children:["Since version 3, it has been possible to use ",(0,a.jsx)(n.code,{children:"semantic-release"})," without any trace of it or the OpenSauced configuration anywhere in the dependency tree."]}),"\n",(0,a.jsxs)(n.p,{children:["Docker containers are pushed as part of the release, so they mirror the availability of ",(0,a.jsx)(n.code,{children:"npm"})," packages."]}),"\n",(0,a.jsxs)(n.p,{children:["The simplest use case for a typical ",(0,a.jsx)(n.code,{children:"npm"})," package is almost zero install downtime from ",(0,a.jsx)(n.code,{children:"ghcr"})," and no more local tooling:"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-yaml",children:'name: "Release container"\n\non:\n push:\n branches:\n - main\n\njobs:\n release:\n environment:\n name: production\n url: https://github.com/${{ github.repository }}/releases/tag/${{ env.RELEASE_TAG }}\n runs-on: ubuntu-latest\n steps:\n - name: "\u2601\ufe0f checkout repository"\n uses: actions/checkout@v2\n with:\n fetch-depth: 0\n\n - name: "\ud83d\ude80 release"\n id: semantic-release\n uses: docker://ghcr.io/open-sauced/semantic-release-conventional-config:3.0.0\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n NPM_TOKEN: ${{ secrets.NPM_TOKEN }}\n\n - name: "\u267b\ufe0f cleanup"\n run: |\n echo ${{ env.RELEASE_TAG }}\n echo ${{ env.RELEASE_VERSION }}\n'})}),"\n",(0,a.jsx)(n.p,{children:"Marketplace actions should default to the major tag and are essentially more stable as we have to curate every release."}),"\n",(0,a.jsx)(n.p,{children:"A more traditional approach, the only thing really different here is a minor pull overhead and using set outputs instead of environment variables:"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-yaml",children:'name: "Release"\n\non:\n push:\n branches:\n - main\n\njobs:\n release:\n environment:\n name: production\n url: https://github.com/${{ github.repository }}/releases/tag/${{ steps.semantic-release.outputs.release-tag }}\n name: Semantic release\n runs-on: ubuntu-latest\n steps:\n - name: "\u2601\ufe0f checkout repository"\n uses: actions/checkout@v2\n with:\n fetch-depth: 0\n\n - name: "\ud83d\ude80 release"\n id: semantic-release\n uses: open-sauced/semantic-release-conventional-config@v3\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n NPM_TOKEN: ${{ secrets.NPM_TOKEN }}\n\n - name: "\u267b\ufe0f cleanup"\n run: |\n echo ${{ steps.semantic-release.outputs.release-tag }}\n echo ${{ steps.semantic-release.outputs.release-version }}\n'})}),"\n",(0,a.jsxs)(n.h2,{id:"-npm-usage",children:["\ud83d\udce6 ",(0,a.jsx)(n.code,{children:"npm"})," Usage"]}),"\n",(0,a.jsxs)(n.p,{children:["You can opt to use this package in your local tooling. Proceed as you would normally would, replacing ",(0,a.jsx)(n.code,{children:"npm"})," with your package manager of choice and install the package:"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-shell",children:"npm install --save-dev @open-sauced/semantic-release-conventional-config\n"})}),"\n",(0,a.jsxs)(n.p,{children:["The shareable config can then be configured in the ",(0,a.jsxs)(n.a,{href:"https://github.com/semantic-release/semantic-release/blob/master/docs/usage/configuration.md#configuration",children:[" ",(0,a.jsx)(n.code,{children:"semantic-release"})," configuration file"]}),":"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-json",children:'{\n "extends": "@open-sauced/semantic-release-conventional-config"\n}\n'})}),"\n",(0,a.jsx)(n.p,{children:"Now, all you need to do is create a release:"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-shell",children:"npx semantic-release\n"})}),"\n",(0,a.jsx)(n.h2,{id:"-configuration",children:"\ud83d\udd27 Configuration"}),"\n",(0,a.jsx)(n.p,{children:"See each plugin official documentation for the required installation and configuration steps."}),"\n",(0,a.jsx)(n.h3,{id:"npm",children:(0,a.jsx)(n.code,{children:"npm"})}),"\n",(0,a.jsxs)(n.p,{children:["Set ",(0,a.jsx)(n.code,{children:"private"})," to true in ",(0,a.jsx)(n.code,{children:"package.json"})," if you want to disable ",(0,a.jsx)(n.code,{children:"npm"})," or change the scope of package using ",(0,a.jsx)(n.code,{children:"publishConfig"}),"."]}),"\n",(0,a.jsxs)(n.p,{children:["Keep one of the ",(0,a.jsx)(n.code,{children:"files"})," or ",(0,a.jsx)(n.code,{children:"main"})," keys in your ",(0,a.jsx)(n.code,{children:"package.json"})," accurate, depending on whether you are building a library or an application."]}),"\n",(0,a.jsxs)(n.p,{children:["If you publish, make sure to also provide a valid ",(0,a.jsx)(n.code,{children:"NPM_TOKEN"}),", as ",(0,a.jsx)(n.code,{children:".npmrc"})," authentication is ignored in our config!"]}),"\n",(0,a.jsx)(n.h3,{id:"github-actions",children:"GitHub Actions"}),"\n",(0,a.jsxs)(n.p,{children:["Unless you have an ",(0,a.jsx)(n.code,{children:"action.yml"})," present in your root folder, this module is not added to the release config."]}),"\n",(0,a.jsxs)(n.p,{children:["If you have an ",(0,a.jsx)(n.code,{children:"action.yml"})," present, our config will attempt to adjust the container version to the newly pushed ",(0,a.jsx)(n.code,{children:"npm"})," and ",(0,a.jsx)(n.code,{children:"docker"})," tags."]}),"\n",(0,a.jsx)(n.h3,{id:"docker",children:"Docker"}),"\n",(0,a.jsxs)(n.p,{children:["Unless you have a ",(0,a.jsx)(n.code,{children:"Dockerfile"})," present in your root folder, this module is not added to the release config."]}),"\n",(0,a.jsxs)(n.p,{children:["If you have a ",(0,a.jsx)(n.code,{children:"Dockerfile"})," present, our config will attempt to push to ",(0,a.jsx)(n.code,{children:"ghcr.io"}),"."]}),"\n",(0,a.jsx)(n.h3,{id:"environment-variables",children:"Environment Variables"}),"\n",(0,a.jsx)(n.p,{children:"Using our configuration comes with some sensible defaults:"}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.code,{children:"DOCKER_USERNAME=$GITHUB_REPOSITORY_OWNER"})}),"\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.code,{children:"DOCKER_PASSWORD=$GITHUB_TOKEN"})}),"\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.code,{children:'GIT_COMMITTER_NAME="open-sauced[bot]"'})}),"\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.code,{children:'GIT_COMMITTER_EMAIL="63161813+open-sauced[bot]@users.noreply.github.com"'})}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.code,{children:"GIT_AUTHOR_NAME"})," - parsed from commit ",(0,a.jsx)(n.code,{children:"$GITHUB_SHA"})]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.code,{children:"GIT_AUTHOR_EMAIL"})," - parsed from commit ",(0,a.jsx)(n.code,{children:"$GITHUB_SHA"})]}),"\n"]}),"\n",(0,a.jsxs)(n.p,{children:["Feel free to change any of the above to whatever suits your purpose. Our motivation is to keep ",(0,a.jsx)(n.code,{children:"GITHUB_TOKEN"})," and/or ",(0,a.jsx)(n.code,{children:"NPM_TOKEN"})," the only necessary requirements."]}),"\n",(0,a.jsx)(n.p,{children:"We are actively investigating ways to drop the two remaining variables as well!"}),"\n",(0,a.jsx)(n.h2,{id:"workflow-examples",children:"Workflow Examples"}),"\n",(0,a.jsx)(n.h3,{id:"node-application",children:"Node Application"}),"\n",(0,a.jsxs)(n.p,{children:["This example requires ",(0,a.jsx)(n.code,{children:'"private": true,'})," in your ",(0,a.jsx)(n.code,{children:"package.json"})," and simplifies the workflow to lightning-fast deployment:"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-yaml",children:'release:\n environment:\n name: production\n url: https://github.com/${{ github.repository }}/releases/tag/${{ env.RELEASE_TAG }}\n name: Semantic release\n runs-on: ubuntu-latest\n steps:\n - name: "\u2601\ufe0f checkout repository"\n uses: actions/checkout@v2\n with:\n fetch-depth: 0\n\n - name: "\ud83d\udd27 setup node"\n uses: actions/setup-node@v2.1.5\n with:\n node-version: 16\n\n - name: "\ud83d\udd27 install npm@latest"\n run: npm i -g npm@latest\n\n - name: "\ud83d\udce6 install dependencies"\n uses: bahmutov/npm-install@v1\n\n - name: "\ud83d\ude80 static app"\n run: npm run build\n\n - name: "\ud83d\ude80 release"\n id: semantic-release\n uses: docker://ghcr.io/open-sauced/semantic-release-conventional-config:3.0.0\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n'})}),"\n",(0,a.jsxs)(n.h3,{id:"npm-library",children:[(0,a.jsx)(n.code,{children:"npm"})," Library"]}),"\n",(0,a.jsxs)(n.p,{children:["For ",(0,a.jsx)(n.code,{children:"npm"})," libraries, we need to set the environment URL manually and set a ",(0,a.jsx)(n.code,{children:"NPM_TOKEN"})," environment variable. This also disables ",(0,a.jsx)(n.code,{children:"docker builds"}),":"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-yaml",children:'name: "Release"\n\non:\n push:\n branches:\n - main\n\njobs:\n release:\n environment:\n name: npm\n url: https://www.npmjs.com/package/@open-sauced/semantic-release-conventional-config/v/${{ env.RELEASE_VERSION }}\n name: Semantic release\n runs-on: ubuntu-latest\n steps:\n - name: "\u2601\ufe0f checkout repository"\n uses: actions/checkout@v2\n with:\n fetch-depth: 0\n\n - name: "\ud83d\udd27 setup node"\n uses: actions/setup-node@v2.1.5\n with:\n node-version: 16\n\n - name: "\ud83d\udd27 install npm@latest"\n run: npm i -g npm@latest\n\n - name: "\ud83d\udce6 install dependencies"\n uses: bahmutov/npm-install@v1\n\n - name: "\ud83d\ude80 release"\n id: semantic-release\n uses: docker://ghcr.io/open-sauced/semantic-release-conventional-config:3.0.0\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n NPM_TOKEN: ${{ secrets.NPM_TOKEN }}\n'})}),"\n",(0,a.jsxs)(n.p,{children:["An up-to-date version of the example above is available at ",(0,a.jsx)(n.a,{href:"https://github.com/open-sauced/semantic-release-conventional-config/blob/main/.github/workflows/release.yml",children:"@open-sauced/semantic-release-conventional-config"}),"."]}),"\n",(0,a.jsx)(n.h3,{id:"docker-image",children:"Docker Image"}),"\n",(0,a.jsxs)(n.p,{children:["For ",(0,a.jsx)(n.code,{children:"docker builds"}),", it's best to build your node application in parallel with the container and re-use the artifact at a later stage:"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-yaml",children:'name: "Release"\n\non:\n push:\n branches:\n - main\n\njobs:\n docker:\n name: Build container\n runs-on: ubuntu-latest\n steps:\n - name: "\u2601\ufe0f checkout repository"\n uses: actions/checkout@v2\n\n - name: "\ud83d\udd27 setup buildx"\n uses: docker/setup-buildx-action@v1\n\n - name: "\ud83d\udd27 cache docker layers"\n uses: actions/cache@v2\n with:\n path: /tmp/.buildx-cache\n key: ${{ runner.os }}-buildx-${{ github.sha }}\n restore-keys: |\n ${{ runner.os }}-buildx-\n\n - name: "\ud83d\udd27 docker meta"\n id: meta\n uses: docker/metadata-action@v3\n with:\n images: ${{ github.repository }}\n tags: latest\n\n - name: "\ud83d\udce6 docker build"\n uses: docker/build-push-action@v2\n with:\n context: .\n tags: ${{ steps.meta.outputs.tags }}\n labels: ${{ steps.meta.outputs.labels }}\n outputs: type=docker,dest=/tmp/docker.tar\n push: false\n cache-from: type=gha, scope=${{ github.workflow }}\n cache-to: type=gha, scope=${{ github.workflow }}\n\n - name: "\ud83d\udcc2 docker artifacts"\n uses: actions/upload-artifact@v2\n with:\n name: docker\n path: /tmp/docker.tar\n\n build:\n name: Build application\n runs-on: ubuntu-latest\n steps:\n - name: "\u2601\ufe0f checkout repository"\n uses: actions/checkout@v2\n\n - name: "\ud83d\udd27 setup node"\n uses: actions/setup-node@v2.1.5\n with:\n node-version: 16\n\n - name: "\ud83d\udd27 install npm@latest"\n run: npm i -g npm@latest\n\n - name: "\ud83d\udce6 install dependencies"\n uses: bahmutov/npm-install@v1\n\n - name: "\ud83d\udcca repository visualizer"\n id: diagram\n uses: githubocto/repo-visualizer@0.7.1\n with:\n excluded_paths: "node_modules,build,.storybook,.netlify,.github,npm-shrinkwap.json"\n output_file: "public/diagram.svg"\n should_push: false\n artifact_name: "diagram"\n\n - name: "\ud83d\ude80 static app"\n run: npm run build\n\n - name: "\ud83d\udcc2 production artifacts"\n uses: actions/upload-artifact@v2\n with:\n name: build\n path: build\n\n release:\n environment:\n name: production\n url: https://github.com/${{ github.repository }}/releases/tag/${{ env.RELEASE_TAG }}\n name: Semantic release\n needs:\n - docker\n - build\n runs-on: ubuntu-latest\n steps:\n - name: "\u2601\ufe0f checkout repository"\n uses: actions/checkout@v2\n with:\n fetch-depth: 0\n\n - name: "\ud83d\udcc2 download docker artifacts"\n uses: actions/download-artifact@v2\n with:\n name: docker\n path: /tmp\n\n - name: "\ud83d\udce6 load tag"\n run: |\n docker load --input /tmp/docker.tar\n docker image ls -a\n\n - name: "\ud83d\udcc2 download build artifacts"\n uses: actions/download-artifact@v2\n with:\n name: build\n path: /tmp/build\n\n - name: "\ud83d\ude80 release"\n id: semantic-release\n uses: docker://ghcr.io/open-sauced/semantic-release-conventional-config:3.0.0\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n\n cleanup:\n name: Cleanup actions\n needs:\n - release\n runs-on: ubuntu-latest\n steps:\n - name: "\u267b\ufe0f remove build artifacts"\n uses: geekyeggo/delete-artifact@v1\n with:\n name: |\n build\n docker\n'})}),"\n",(0,a.jsxs)(n.p,{children:["An up-to-date version of the example above is available at ",(0,a.jsx)(n.a,{href:"https://github.com/open-sauced/open-sauced/blob/main/.github/workflows/release.yml",children:"open-sauced/open-sauced"}),"."]}),"\n",(0,a.jsx)(n.h3,{id:"pre-releases",children:"Pre-Releases"}),"\n",(0,a.jsxs)(n.p,{children:["This workflow requires the creation of ",(0,a.jsx)(n.code,{children:"alpha"})," and ",(0,a.jsx)(n.code,{children:"beta"})," protected branches while templating every commit to be conventional. It does not support squashing without creating extremely complex conflict resolution:"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-yaml",children:'name: "Release"\n\non:\n push:\n branches:\n - main\n - beta\n - alpha\n\njobs:\n release:\n environment:\n name: npm\n url: https://www.npmjs.com/package/open-sauced-semantic-config-test/v/${{ steps.release.outputs.version }}\n name: Semantic release\n runs-on: ubuntu-latest\n steps:\n - name: "\u2601\ufe0f checkout repository"\n uses: actions/checkout@v2\n with:\n fetch-depth: 0\n\n - name: "\ud83d\ude80 release"\n id: semantic-release\n uses: docker://ghcr.io/open-sauced/semantic-release-conventional-config:3.0.0\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n NPM_TOKEN: ${{ secrets.NPM_TOKEN }}\n'})}),"\n",(0,a.jsx)(n.h2,{id:"faqs",children:"FAQs"}),"\n",(0,a.jsx)(n.h3,{id:"which-assets-are-pushed-to-git",children:"Which Assets are Pushed to Git?"}),"\n",(0,a.jsxs)(n.p,{children:["The following assets are added to git using ",(0,a.jsx)(n.code,{children:"@semantic-release/git"}),":"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-json",children:'{\n "assets": [\n "LICENSE",\n "LICENSE.md",\n "COPYING",\n "COPYING.md",\n "CHANGELOG.md",\n "package.json",\n "package-lock.json",\n "npm-shrinkwrap.json",\n "public/diagram.svg",\n "action.yml"\n ]\n}\n'})}),"\n",(0,a.jsx)(n.h3,{id:"what-is-the-commit-convention",children:"What is the Commit Convention?"}),"\n",(0,a.jsxs)(n.p,{children:["The following commit rules are enforced by ",(0,a.jsx)(n.code,{children:"@semantic-release/commit-analyzer"}),":"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-json",children:'{\n "preset": "conventionalcommits",\n "releaseRules": [\n { "type": "build", "release": "minor" },\n { "type": "ci", "release": "patch" },\n { "type": "docs", "release": "minor" },\n { "type": "style", "release": "patch" },\n { "type": "refactor", "release": "patch" },\n { "type": "test", "release": "patch" },\n { "type": "revert", "release": "patch" },\n { "type": "chore", "release": false }\n ],\n "parserOpts": {\n "noteKeywords": ["BREAKING CHANGE", "BREAKING CHANGES", "BREAKING"]\n }\n}\n'})}),"\n",(0,a.jsx)(n.h3,{id:"how-to-enrich-the-static-distribution",children:"How to Enrich the Static Distribution?"}),"\n",(0,a.jsxs)(n.p,{children:["The following assets are packed into the github release download using ",(0,a.jsx)(n.code,{children:"@semantic-release/github"}),":"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-json",children:'{\n "assets": [\n {\n "path": "pack/*.tgz",\n "label": "Static distribution"\n }\n ]\n}\n'})}),"\n",(0,a.jsx)(n.h3,{id:"how-to-start-using-pre-releases",children:"How to Start Using Pre-Releases?"}),"\n",(0,a.jsxs)(n.p,{children:["Create the ",(0,a.jsx)(n.code,{children:"alpha"})," and/or ",(0,a.jsx)(n.code,{children:"beta"})," branches and protect them from being deleted or pushed directly by non-administrators."]}),"\n",(0,a.jsxs)(n.p,{children:["Switch your branching strategy to ",(0,a.jsx)(n.code,{children:"merge"})," and enable conventional commits checking."]}),"\n",(0,a.jsxs)(n.p,{children:["As described in the ",(0,a.jsx)(n.a,{href:"https://github.com/semantic-release/semantic-release/tree/master/docs/recipes",children:"semantic-releases recipes"}),", you will have to resolve merge conflicts between ",(0,a.jsx)(n.code,{children:"alpha"}),", ",(0,a.jsx)(n.code,{children:"beta"}),", and ",(0,a.jsx)(n.code,{children:"main"})," branches."]}),"\n",(0,a.jsx)(n.h2,{id:"contributing",children:"Contributing"}),"\n",(0,a.jsx)(n.p,{children:"We're always happy to onboard people into open source!"}),"\n",(0,a.jsxs)(n.p,{children:["Check out the repository at ",(0,a.jsx)(n.a,{href:"https://github.com/open-sauced/semantic-release-conventional-config",children:"@open-sauced/semantic-release-conventional-config"}),". \u2764\ufe0f"]})]})}function h(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(d,{...e})}):d(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>c,x:()=>o});var a=s(6540);const i={},t=a.createContext(i);function c(e){const n=a.useContext(t);return a.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),a.createElement(t.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/0f97bf69.e9a6f66b.js b/assets/js/0f97bf69.e9a6f66b.js
new file mode 100644
index 00000000..01eea52f
--- /dev/null
+++ b/assets/js/0f97bf69.e9a6f66b.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunk_open_sauced_docs_opensauced_pizza=self.webpackChunk_open_sauced_docs_opensauced_pizza||[]).push([[5234],{6658:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>r,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>o,toc:()=>l});var a=s(4848),i=s(8453);const t={id:"semantic-release",title:"@open-sauced/semantic-release-conventional-config",sidebar_label:"@open-sauced/semantic-release-conventional-config",keywords:["semantic release"]},c=void 0,o={id:"opensauced-packages/semantic-release",title:"@open-sauced/semantic-release-conventional-config",description:"Description",source:"@site/docs/opensauced-packages/semantic-release.md",sourceDirName:"opensauced-packages",slug:"/opensauced-packages/semantic-release",permalink:"/opensauced-packages/semantic-release",draft:!1,unlisted:!1,editUrl:"https://github.com/open-sauced/docs.opensauced.pizza/edit/main/docs/opensauced-packages/semantic-release.md",tags:[],version:"current",lastUpdatedBy:"BekahHW",lastUpdatedAt:1717170876e3,frontMatter:{id:"semantic-release",title:"@open-sauced/semantic-release-conventional-config",sidebar_label:"@open-sauced/semantic-release-conventional-config",keywords:["semantic release"]},sidebar:"docs",previous:{title:"@open-sauced/conventional-commit",permalink:"/opensauced-packages/conventional-commit"}},r={},l=[{value:"Description",id:"description",level:2},{value:"Dependencies",id:"dependencies",level:2},{value:"\ud83d\udda5\ufe0f Requirements",id:"\ufe0f-requirements",level:2},{value:"\ud83e\uddea GitHub Actions Usage",id:"-github-actions-usage",level:2},{value:"\ud83d\udce6 npm Usage",id:"-npm-usage",level:2},{value:"\ud83d\udd27 Configuration",id:"-configuration",level:2},{value:"npm",id:"npm",level:3},{value:"GitHub Actions",id:"github-actions",level:3},{value:"Docker",id:"docker",level:3},{value:"Environment Variables",id:"environment-variables",level:3},{value:"Workflow Examples",id:"workflow-examples",level:2},{value:"Node Application",id:"node-application",level:3},{value:"npm Library",id:"npm-library",level:3},{value:"Docker Image",id:"docker-image",level:3},{value:"Pre-Releases",id:"pre-releases",level:3},{value:"FAQs",id:"faqs",level:2},{value:"Which Assets are Pushed to Git?",id:"which-assets-are-pushed-to-git",level:3},{value:"What is the Commit Convention?",id:"what-is-the-commit-convention",level:3},{value:"How to Enrich the Static Distribution?",id:"how-to-enrich-the-static-distribution",level:3},{value:"How to Start Using Pre-Releases?",id:"how-to-start-using-pre-releases",level:3},{value:"Contributing",id:"contributing",level:2}];function d(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",li:"li",p:"p",pre:"pre",ul:"ul",...(0,i.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(n.h2,{id:"description",children:"Description"}),"\n",(0,a.jsxs)(n.p,{children:["The ",(0,a.jsx)(n.code,{children:"npm"})," package ",(0,a.jsx)(n.code,{children:"@open-sauced/semantic-release-conventional-config"})," is designed to help ",(0,a.jsx)(n.code,{children:"npm"})," packages auto-release to ",(0,a.jsx)(n.code,{children:"npm"})," or ",(0,a.jsx)(n.a,{href:"https://ghcr.io",children:(0,a.jsx)(n.code,{children:"ghcr"})})," registries while generating GitHub releases and changelog using conventional commit convention."]}),"\n",(0,a.jsx)(n.p,{children:"Version 2 supports alpha and beta pre-releases using corresponding branches."}),"\n",(0,a.jsx)(n.h2,{id:"dependencies",children:"Dependencies"}),"\n",(0,a.jsx)(n.p,{children:"This package uses the following modules:"}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.a,{href:"https://github.com/semantic-release/commit-analyzer",children:(0,a.jsx)(n.code,{children:"@semantic-release/commit-analyzer"})})}),"\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.a,{href:"https://github.com/semantic-release/release-notes-generator",children:(0,a.jsx)(n.code,{children:"@semantic-release/release-notes-generator"})})}),"\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.a,{href:"https://github.com/conventional-changelog/conventional-changelog",children:(0,a.jsx)(n.code,{children:"@conventional-changelog/conventional-changelog"})})}),"\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.a,{href:"https://github.com/semantic-release/changelog",children:(0,a.jsx)(n.code,{children:"@semantic-release/changelog"})})}),"\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.a,{href:"https://github.com/semantic-release/npm",children:(0,a.jsx)(n.code,{children:"@semantic-release/npm"})})}),"\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.a,{href:"https://github.com/google/semantic-release-replace-plugin",children:(0,a.jsx)(n.code,{children:"@google/semantic-release-replace-plugin"})})}),"\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.a,{href:"https://github.com/cbhq/semantic-release-license",children:(0,a.jsx)(n.code,{children:"@cbhq/semantic-release-license"})})}),"\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.a,{href:"https://github.com/semantic-release/git",children:(0,a.jsx)(n.code,{children:"@semantic-release/git"})})}),"\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.a,{href:"https://github.com/semantic-release/github",children:(0,a.jsx)(n.code,{children:"@semantic-release/github"})})}),"\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.a,{href:"https://github.com/eclass/semantic-release-docker",children:(0,a.jsx)(n.code,{children:"@eclass/semantic-release-docker"})})}),"\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.a,{href:"https://github.com/semantic-release/exec",children:(0,a.jsx)(n.code,{children:"@semantic-release/exec"})})}),"\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.a,{href:"https://github.com/sindresorhus/execa",children:(0,a.jsx)(n.code,{children:"execa"})})}),"\n"]}),"\n",(0,a.jsx)(n.h2,{id:"\ufe0f-requirements",children:"\ud83d\udda5\ufe0f Requirements"}),"\n",(0,a.jsx)(n.p,{children:"Most important limitations are:"}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.code,{children:"GITHUB_TOKEN"})," for everything"]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.code,{children:"NPM_TOKEN"})," for public ",(0,a.jsx)(n.code,{children:"npm"})," library"]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.code,{children:"docker"})," containers need to be built beforehand"]}),"\n"]}),"\n",(0,a.jsxs)(n.p,{children:["You can skip here if you are using an elevated ",(0,a.jsx)(n.a,{href:"https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token",children:"Private Access Token"}),". However, we don't recommend going down that path."]}),"\n",(0,a.jsx)(n.p,{children:"No force push or admin cherries branch protections for the following branches:"}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.code,{children:"main"})," - required"]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.code,{children:"alpha"})," - optional, pre-release branch"]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.code,{children:"beta"})," - optional, pre-release branch"]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.code,{children:"next"})," - optional, next channel"]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.code,{children:"next-major"})," - optional, next major"]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.code,{children:"vX[.X.X]"})," - maintenance releases"]}),"\n"]}),"\n",(0,a.jsxs)(n.p,{children:["If you use more than the ",(0,a.jsx)(n.code,{children:"main"})," branch, optionally create an environment that limits where pushes can come from and enable the merge strategy."]}),"\n",(0,a.jsxs)(n.p,{children:["We use ",(0,a.jsx)(n.code,{children:"production"})," in our examples; if you copy-paste them, you will find this new environment generated in your settings! \ud83c\udf55"]}),"\n",(0,a.jsx)(n.h2,{id:"-github-actions-usage",children:"\ud83e\uddea GitHub Actions Usage"}),"\n",(0,a.jsxs)(n.p,{children:["Since version 3, it has been possible to use ",(0,a.jsx)(n.code,{children:"semantic-release"})," without any trace of it or the OpenSauced configuration anywhere in the dependency tree."]}),"\n",(0,a.jsxs)(n.p,{children:["Docker containers are pushed as part of the release, so they mirror the availability of ",(0,a.jsx)(n.code,{children:"npm"})," packages."]}),"\n",(0,a.jsxs)(n.p,{children:["The simplest use case for a typical ",(0,a.jsx)(n.code,{children:"npm"})," package is almost zero install downtime from ",(0,a.jsx)(n.code,{children:"ghcr"})," and no more local tooling:"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-yaml",children:'name: "Release container"\n\non:\n push:\n branches:\n - main\n\njobs:\n release:\n environment:\n name: production\n url: https://github.com/${{ github.repository }}/releases/tag/${{ env.RELEASE_TAG }}\n runs-on: ubuntu-latest\n steps:\n - name: "\u2601\ufe0f checkout repository"\n uses: actions/checkout@v2\n with:\n fetch-depth: 0\n\n - name: "\ud83d\ude80 release"\n id: semantic-release\n uses: docker://ghcr.io/open-sauced/semantic-release-conventional-config:3.0.0\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n NPM_TOKEN: ${{ secrets.NPM_TOKEN }}\n\n - name: "\u267b\ufe0f cleanup"\n run: |\n echo ${{ env.RELEASE_TAG }}\n echo ${{ env.RELEASE_VERSION }}\n'})}),"\n",(0,a.jsx)(n.p,{children:"Marketplace actions should default to the major tag and are essentially more stable as we have to curate every release."}),"\n",(0,a.jsx)(n.p,{children:"A more traditional approach, the only thing really different here is a minor pull overhead and using set outputs instead of environment variables:"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-yaml",children:'name: "Release"\n\non:\n push:\n branches:\n - main\n\njobs:\n release:\n environment:\n name: production\n url: https://github.com/${{ github.repository }}/releases/tag/${{ steps.semantic-release.outputs.release-tag }}\n name: Semantic release\n runs-on: ubuntu-latest\n steps:\n - name: "\u2601\ufe0f checkout repository"\n uses: actions/checkout@v2\n with:\n fetch-depth: 0\n\n - name: "\ud83d\ude80 release"\n id: semantic-release\n uses: open-sauced/semantic-release-conventional-config@v3\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n NPM_TOKEN: ${{ secrets.NPM_TOKEN }}\n\n - name: "\u267b\ufe0f cleanup"\n run: |\n echo ${{ steps.semantic-release.outputs.release-tag }}\n echo ${{ steps.semantic-release.outputs.release-version }}\n'})}),"\n",(0,a.jsxs)(n.h2,{id:"-npm-usage",children:["\ud83d\udce6 ",(0,a.jsx)(n.code,{children:"npm"})," Usage"]}),"\n",(0,a.jsxs)(n.p,{children:["You can opt to use this package in your local tooling. Proceed as you would normally would, replacing ",(0,a.jsx)(n.code,{children:"npm"})," with your package manager of choice and install the package:"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-shell",children:"npm install --save-dev @open-sauced/semantic-release-conventional-config\n"})}),"\n",(0,a.jsxs)(n.p,{children:["The shareable config can then be configured in the ",(0,a.jsxs)(n.a,{href:"https://github.com/semantic-release/semantic-release/blob/master/docs/usage/configuration.md#configuration",children:[" ",(0,a.jsx)(n.code,{children:"semantic-release"})," configuration file"]}),":"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-json",children:'{\n "extends": "@open-sauced/semantic-release-conventional-config"\n}\n'})}),"\n",(0,a.jsx)(n.p,{children:"Now, all you need to do is create a release:"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-shell",children:"npx semantic-release\n"})}),"\n",(0,a.jsx)(n.h2,{id:"-configuration",children:"\ud83d\udd27 Configuration"}),"\n",(0,a.jsx)(n.p,{children:"See each plugin official documentation for the required installation and configuration steps."}),"\n",(0,a.jsx)(n.h3,{id:"npm",children:(0,a.jsx)(n.code,{children:"npm"})}),"\n",(0,a.jsxs)(n.p,{children:["Set ",(0,a.jsx)(n.code,{children:"private"})," to true in ",(0,a.jsx)(n.code,{children:"package.json"})," if you want to disable ",(0,a.jsx)(n.code,{children:"npm"})," or change the scope of package using ",(0,a.jsx)(n.code,{children:"publishConfig"}),"."]}),"\n",(0,a.jsxs)(n.p,{children:["Keep one of the ",(0,a.jsx)(n.code,{children:"files"})," or ",(0,a.jsx)(n.code,{children:"main"})," keys in your ",(0,a.jsx)(n.code,{children:"package.json"})," accurate, depending on whether you are building a library or an application."]}),"\n",(0,a.jsxs)(n.p,{children:["If you publish, make sure to also provide a valid ",(0,a.jsx)(n.code,{children:"NPM_TOKEN"}),", as ",(0,a.jsx)(n.code,{children:".npmrc"})," authentication is ignored in our config!"]}),"\n",(0,a.jsx)(n.h3,{id:"github-actions",children:"GitHub Actions"}),"\n",(0,a.jsxs)(n.p,{children:["Unless you have an ",(0,a.jsx)(n.code,{children:"action.yml"})," present in your root folder, this module is not added to the release config."]}),"\n",(0,a.jsxs)(n.p,{children:["If you have an ",(0,a.jsx)(n.code,{children:"action.yml"})," present, our config will attempt to adjust the container version to the newly pushed ",(0,a.jsx)(n.code,{children:"npm"})," and ",(0,a.jsx)(n.code,{children:"docker"})," tags."]}),"\n",(0,a.jsx)(n.h3,{id:"docker",children:"Docker"}),"\n",(0,a.jsxs)(n.p,{children:["Unless you have a ",(0,a.jsx)(n.code,{children:"Dockerfile"})," present in your root folder, this module is not added to the release config."]}),"\n",(0,a.jsxs)(n.p,{children:["If you have a ",(0,a.jsx)(n.code,{children:"Dockerfile"})," present, our config will attempt to push to ",(0,a.jsx)(n.code,{children:"ghcr.io"}),"."]}),"\n",(0,a.jsx)(n.h3,{id:"environment-variables",children:"Environment Variables"}),"\n",(0,a.jsx)(n.p,{children:"Using our configuration comes with some sensible defaults:"}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.code,{children:"DOCKER_USERNAME=$GITHUB_REPOSITORY_OWNER"})}),"\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.code,{children:"DOCKER_PASSWORD=$GITHUB_TOKEN"})}),"\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.code,{children:'GIT_COMMITTER_NAME="open-sauced[bot]"'})}),"\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.code,{children:'GIT_COMMITTER_EMAIL="63161813+open-sauced[bot]@users.noreply.github.com"'})}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.code,{children:"GIT_AUTHOR_NAME"})," - parsed from commit ",(0,a.jsx)(n.code,{children:"$GITHUB_SHA"})]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.code,{children:"GIT_AUTHOR_EMAIL"})," - parsed from commit ",(0,a.jsx)(n.code,{children:"$GITHUB_SHA"})]}),"\n"]}),"\n",(0,a.jsxs)(n.p,{children:["Feel free to change any of the above to whatever suits your purpose. Our motivation is to keep ",(0,a.jsx)(n.code,{children:"GITHUB_TOKEN"})," and/or ",(0,a.jsx)(n.code,{children:"NPM_TOKEN"})," the only necessary requirements."]}),"\n",(0,a.jsx)(n.p,{children:"We are actively investigating ways to drop the two remaining variables as well!"}),"\n",(0,a.jsx)(n.h2,{id:"workflow-examples",children:"Workflow Examples"}),"\n",(0,a.jsx)(n.h3,{id:"node-application",children:"Node Application"}),"\n",(0,a.jsxs)(n.p,{children:["This example requires ",(0,a.jsx)(n.code,{children:'"private": true,'})," in your ",(0,a.jsx)(n.code,{children:"package.json"})," and simplifies the workflow to lightning-fast deployment:"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-yaml",children:'release:\n environment:\n name: production\n url: https://github.com/${{ github.repository }}/releases/tag/${{ env.RELEASE_TAG }}\n name: Semantic release\n runs-on: ubuntu-latest\n steps:\n - name: "\u2601\ufe0f checkout repository"\n uses: actions/checkout@v2\n with:\n fetch-depth: 0\n\n - name: "\ud83d\udd27 setup node"\n uses: actions/setup-node@v2.1.5\n with:\n node-version: 16\n\n - name: "\ud83d\udd27 install npm@latest"\n run: npm i -g npm@latest\n\n - name: "\ud83d\udce6 install dependencies"\n uses: bahmutov/npm-install@v1\n\n - name: "\ud83d\ude80 static app"\n run: npm run build\n\n - name: "\ud83d\ude80 release"\n id: semantic-release\n uses: docker://ghcr.io/open-sauced/semantic-release-conventional-config:3.0.0\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n'})}),"\n",(0,a.jsxs)(n.h3,{id:"npm-library",children:[(0,a.jsx)(n.code,{children:"npm"})," Library"]}),"\n",(0,a.jsxs)(n.p,{children:["For ",(0,a.jsx)(n.code,{children:"npm"})," libraries, we need to set the environment URL manually and set a ",(0,a.jsx)(n.code,{children:"NPM_TOKEN"})," environment variable. This also disables ",(0,a.jsx)(n.code,{children:"docker builds"}),":"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-yaml",children:'name: "Release"\n\non:\n push:\n branches:\n - main\n\njobs:\n release:\n environment:\n name: npm\n url: https://www.npmjs.com/package/@open-sauced/semantic-release-conventional-config/v/${{ env.RELEASE_VERSION }}\n name: Semantic release\n runs-on: ubuntu-latest\n steps:\n - name: "\u2601\ufe0f checkout repository"\n uses: actions/checkout@v2\n with:\n fetch-depth: 0\n\n - name: "\ud83d\udd27 setup node"\n uses: actions/setup-node@v2.1.5\n with:\n node-version: 16\n\n - name: "\ud83d\udd27 install npm@latest"\n run: npm i -g npm@latest\n\n - name: "\ud83d\udce6 install dependencies"\n uses: bahmutov/npm-install@v1\n\n - name: "\ud83d\ude80 release"\n id: semantic-release\n uses: docker://ghcr.io/open-sauced/semantic-release-conventional-config:3.0.0\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n NPM_TOKEN: ${{ secrets.NPM_TOKEN }}\n'})}),"\n",(0,a.jsxs)(n.p,{children:["An up-to-date version of the example above is available at ",(0,a.jsx)(n.a,{href:"https://github.com/open-sauced/semantic-release-conventional-config/blob/main/.github/workflows/release.yml",children:"@open-sauced/semantic-release-conventional-config"}),"."]}),"\n",(0,a.jsx)(n.h3,{id:"docker-image",children:"Docker Image"}),"\n",(0,a.jsxs)(n.p,{children:["For ",(0,a.jsx)(n.code,{children:"docker builds"}),", it's best to build your node application in parallel with the container and re-use the artifact at a later stage:"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-yaml",children:'name: "Release"\n\non:\n push:\n branches:\n - main\n\njobs:\n docker:\n name: Build container\n runs-on: ubuntu-latest\n steps:\n - name: "\u2601\ufe0f checkout repository"\n uses: actions/checkout@v2\n\n - name: "\ud83d\udd27 setup buildx"\n uses: docker/setup-buildx-action@v1\n\n - name: "\ud83d\udd27 cache docker layers"\n uses: actions/cache@v2\n with:\n path: /tmp/.buildx-cache\n key: ${{ runner.os }}-buildx-${{ github.sha }}\n restore-keys: |\n ${{ runner.os }}-buildx-\n\n - name: "\ud83d\udd27 docker meta"\n id: meta\n uses: docker/metadata-action@v3\n with:\n images: ${{ github.repository }}\n tags: latest\n\n - name: "\ud83d\udce6 docker build"\n uses: docker/build-push-action@v2\n with:\n context: .\n tags: ${{ steps.meta.outputs.tags }}\n labels: ${{ steps.meta.outputs.labels }}\n outputs: type=docker,dest=/tmp/docker.tar\n push: false\n cache-from: type=gha, scope=${{ github.workflow }}\n cache-to: type=gha, scope=${{ github.workflow }}\n\n - name: "\ud83d\udcc2 docker artifacts"\n uses: actions/upload-artifact@v2\n with:\n name: docker\n path: /tmp/docker.tar\n\n build:\n name: Build application\n runs-on: ubuntu-latest\n steps:\n - name: "\u2601\ufe0f checkout repository"\n uses: actions/checkout@v2\n\n - name: "\ud83d\udd27 setup node"\n uses: actions/setup-node@v2.1.5\n with:\n node-version: 16\n\n - name: "\ud83d\udd27 install npm@latest"\n run: npm i -g npm@latest\n\n - name: "\ud83d\udce6 install dependencies"\n uses: bahmutov/npm-install@v1\n\n - name: "\ud83d\udcca repository visualizer"\n id: diagram\n uses: githubocto/repo-visualizer@0.7.1\n with:\n excluded_paths: "node_modules,build,.storybook,.netlify,.github,npm-shrinkwap.json"\n output_file: "public/diagram.svg"\n should_push: false\n artifact_name: "diagram"\n\n - name: "\ud83d\ude80 static app"\n run: npm run build\n\n - name: "\ud83d\udcc2 production artifacts"\n uses: actions/upload-artifact@v2\n with:\n name: build\n path: build\n\n release:\n environment:\n name: production\n url: https://github.com/${{ github.repository }}/releases/tag/${{ env.RELEASE_TAG }}\n name: Semantic release\n needs:\n - docker\n - build\n runs-on: ubuntu-latest\n steps:\n - name: "\u2601\ufe0f checkout repository"\n uses: actions/checkout@v2\n with:\n fetch-depth: 0\n\n - name: "\ud83d\udcc2 download docker artifacts"\n uses: actions/download-artifact@v2\n with:\n name: docker\n path: /tmp\n\n - name: "\ud83d\udce6 load tag"\n run: |\n docker load --input /tmp/docker.tar\n docker image ls -a\n\n - name: "\ud83d\udcc2 download build artifacts"\n uses: actions/download-artifact@v2\n with:\n name: build\n path: /tmp/build\n\n - name: "\ud83d\ude80 release"\n id: semantic-release\n uses: docker://ghcr.io/open-sauced/semantic-release-conventional-config:3.0.0\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n\n cleanup:\n name: Cleanup actions\n needs:\n - release\n runs-on: ubuntu-latest\n steps:\n - name: "\u267b\ufe0f remove build artifacts"\n uses: geekyeggo/delete-artifact@v1\n with:\n name: |\n build\n docker\n'})}),"\n",(0,a.jsxs)(n.p,{children:["An up-to-date version of the example above is available at ",(0,a.jsx)(n.a,{href:"https://github.com/open-sauced/open-sauced/blob/main/.github/workflows/release.yml",children:"open-sauced/open-sauced"}),"."]}),"\n",(0,a.jsx)(n.h3,{id:"pre-releases",children:"Pre-Releases"}),"\n",(0,a.jsxs)(n.p,{children:["This workflow requires the creation of ",(0,a.jsx)(n.code,{children:"alpha"})," and ",(0,a.jsx)(n.code,{children:"beta"})," protected branches while templating every commit to be conventional. It does not support squashing without creating extremely complex conflict resolution:"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-yaml",children:'name: "Release"\n\non:\n push:\n branches:\n - main\n - beta\n - alpha\n\njobs:\n release:\n environment:\n name: npm\n url: https://www.npmjs.com/package/open-sauced-semantic-config-test/v/${{ steps.release.outputs.version }}\n name: Semantic release\n runs-on: ubuntu-latest\n steps:\n - name: "\u2601\ufe0f checkout repository"\n uses: actions/checkout@v2\n with:\n fetch-depth: 0\n\n - name: "\ud83d\ude80 release"\n id: semantic-release\n uses: docker://ghcr.io/open-sauced/semantic-release-conventional-config:3.0.0\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n NPM_TOKEN: ${{ secrets.NPM_TOKEN }}\n'})}),"\n",(0,a.jsx)(n.h2,{id:"faqs",children:"FAQs"}),"\n",(0,a.jsx)(n.h3,{id:"which-assets-are-pushed-to-git",children:"Which Assets are Pushed to Git?"}),"\n",(0,a.jsxs)(n.p,{children:["The following assets are added to git using ",(0,a.jsx)(n.code,{children:"@semantic-release/git"}),":"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-json",children:'{\n "assets": [\n "LICENSE",\n "LICENSE.md",\n "COPYING",\n "COPYING.md",\n "CHANGELOG.md",\n "package.json",\n "package-lock.json",\n "npm-shrinkwrap.json",\n "public/diagram.svg",\n "action.yml"\n ]\n}\n'})}),"\n",(0,a.jsx)(n.h3,{id:"what-is-the-commit-convention",children:"What is the Commit Convention?"}),"\n",(0,a.jsxs)(n.p,{children:["The following commit rules are enforced by ",(0,a.jsx)(n.code,{children:"@semantic-release/commit-analyzer"}),":"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-json",children:'{\n "preset": "conventionalcommits",\n "releaseRules": [\n { "type": "build", "release": "minor" },\n { "type": "ci", "release": "patch" },\n { "type": "docs", "release": "minor" },\n { "type": "style", "release": "patch" },\n { "type": "refactor", "release": "patch" },\n { "type": "test", "release": "patch" },\n { "type": "revert", "release": "patch" },\n { "type": "chore", "release": false }\n ],\n "parserOpts": {\n "noteKeywords": ["BREAKING CHANGE", "BREAKING CHANGES", "BREAKING"]\n }\n}\n'})}),"\n",(0,a.jsx)(n.h3,{id:"how-to-enrich-the-static-distribution",children:"How to Enrich the Static Distribution?"}),"\n",(0,a.jsxs)(n.p,{children:["The following assets are packed into the github release download using ",(0,a.jsx)(n.code,{children:"@semantic-release/github"}),":"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-json",children:'{\n "assets": [\n {\n "path": "pack/*.tgz",\n "label": "Static distribution"\n }\n ]\n}\n'})}),"\n",(0,a.jsx)(n.h3,{id:"how-to-start-using-pre-releases",children:"How to Start Using Pre-Releases?"}),"\n",(0,a.jsxs)(n.p,{children:["Create the ",(0,a.jsx)(n.code,{children:"alpha"})," and/or ",(0,a.jsx)(n.code,{children:"beta"})," branches and protect them from being deleted or pushed directly by non-administrators."]}),"\n",(0,a.jsxs)(n.p,{children:["Switch your branching strategy to ",(0,a.jsx)(n.code,{children:"merge"})," and enable conventional commits checking."]}),"\n",(0,a.jsxs)(n.p,{children:["As described in the ",(0,a.jsx)(n.a,{href:"https://github.com/semantic-release/semantic-release/tree/master/docs/recipes",children:"semantic-releases recipes"}),", you will have to resolve merge conflicts between ",(0,a.jsx)(n.code,{children:"alpha"}),", ",(0,a.jsx)(n.code,{children:"beta"}),", and ",(0,a.jsx)(n.code,{children:"main"})," branches."]}),"\n",(0,a.jsx)(n.h2,{id:"contributing",children:"Contributing"}),"\n",(0,a.jsx)(n.p,{children:"We're always happy to onboard people into open source!"}),"\n",(0,a.jsxs)(n.p,{children:["Check out the repository at ",(0,a.jsx)(n.a,{href:"https://github.com/open-sauced/semantic-release-conventional-config",children:"@open-sauced/semantic-release-conventional-config"}),". \u2764\ufe0f"]})]})}function h(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(d,{...e})}):d(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>c,x:()=>o});var a=s(6540);const i={},t=a.createContext(i);function c(e){const n=a.useContext(t);return a.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),a.createElement(t.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/163a28f8.3ee1b62c.js b/assets/js/163a28f8.3ee1b62c.js
new file mode 100644
index 00000000..62eb4b36
--- /dev/null
+++ b/assets/js/163a28f8.3ee1b62c.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunk_open_sauced_docs_opensauced_pizza=self.webpackChunk_open_sauced_docs_opensauced_pizza||[]).push([[4802],{7028:(e,i,t)=>{t.r(i),t.d(i,{assets:()=>c,contentTitle:()=>s,default:()=>l,frontMatter:()=>r,metadata:()=>a,toc:()=>h});var n=t(4848),o=t(8453);const r={id:"maintainers-guide-to-open-sauced",title:"Maintainers Guide to OpenSauced",sidebar_label:"Maintainers Guide to OpenSauced",keywords:["maintainers","guides","open source maintainers guide","open source maintainer","Maintainers Guide to OpenSauced"]},s=void 0,a={id:"maintainers/maintainers-guide-to-open-sauced",title:"Maintainers Guide to OpenSauced",description:"Introduction to OpenSauced for Maintainers",source:"@site/docs/maintainers/maintainers-guide.md",sourceDirName:"maintainers",slug:"/maintainers/maintainers-guide-to-open-sauced",permalink:"/maintainers/maintainers-guide-to-open-sauced",draft:!1,unlisted:!1,editUrl:"https://github.com/open-sauced/docs.opensauced.pizza/edit/main/docs/maintainers/maintainers-guide.md",tags:[],version:"current",lastUpdatedBy:"BekahHW",lastUpdatedAt:1717170876e3,frontMatter:{id:"maintainers-guide-to-open-sauced",title:"Maintainers Guide to OpenSauced",sidebar_label:"Maintainers Guide to OpenSauced",keywords:["maintainers","guides","open source maintainers guide","open source maintainer","Maintainers Guide to OpenSauced"]},sidebar:"docs",previous:{title:"Students Guide to OpenSauced",permalink:"/opensauced-guides/students-guide/"},next:{title:"Understanding Repo Insights Data",permalink:"/maintainers/understanding-repo-insights"}},c={},h=[{value:"Introduction to OpenSauced for Maintainers",id:"introduction-to-opensauced-for-maintainers",level:2},{value:"Getting Started",id:"getting-started",level:2},{value:"Your Workspace: Streamlining Open Source Project Management",id:"your-workspace-streamlining-open-source-project-management",level:2},{value:"Creating a New Workspace",id:"creating-a-new-workspace",level:3},{value:"Adding Repositories to Your Workspace",id:"adding-repositories-to-your-workspace",level:3},{value:"Navigating Your Workspace",id:"navigating-your-workspace",level:3},{value:"Repositories Dashboard",id:"repositories-dashboard",level:4},{value:"Repository Insights: Connecting Your Repositories",id:"repository-insights-connecting-your-repositories",level:2},{value:"Creating a New Repository Insight Page",id:"creating-a-new-repository-insight-page",level:3},{value:"Using Your Repository Insights Page",id:"using-your-repository-insights-page",level:3},{value:"Repositories Dashboard",id:"repositories-dashboard-1",level:4},{value:"Contributors",id:"contributors",level:4},{value:"Activity",id:"activity",level:4},{value:"Contributor Insights: Connecting with Contributors",id:"contributor-insights-connecting-with-contributors",level:2},{value:"Why Create a Contributor Insight Page?",id:"why-create-a-contributor-insight-page",level:3},{value:"Creating a New Contributor Insight Page",id:"creating-a-new-contributor-insight-page",level:3},{value:"Using Your Contributor Insight Page",id:"using-your-contributor-insight-page",level:2},{value:"Overview",id:"overview",level:3},{value:"Activity",id:"activity-1",level:3},{value:"Highlights",id:"highlights",level:3},{value:"Highlights: Connecting and Recognizing Contributions",id:"highlights-connecting-and-recognizing-contributions",level:2},{value:"Creating a New Highlight",id:"creating-a-new-highlight",level:3},{value:"Writing an Effective Highlight",id:"writing-an-effective-highlight",level:3},{value:"Highlighting Issues",id:"highlighting-issues",level:4},{value:"Highlighting PRs",id:"highlighting-prs",level:4},{value:"Highlighting Blog Posts",id:"highlighting-blog-posts",level:4}];function d(e){const i={a:"a",admonition:"admonition",h2:"h2",h3:"h3",h4:"h4",img:"img",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(i.h2,{id:"introduction-to-opensauced-for-maintainers",children:"Introduction to OpenSauced for Maintainers"}),"\n",(0,n.jsxs)(i.p,{children:["OpenSauced is a platform dedicated to empowering maintainers and redefining open source contributions. We offer a GitHub-powered dashboard for tracking contributions and gaining insights into your open source projects. You can create a ",(0,n.jsx)(i.a,{href:"#your-workspace-streamlining-open-source-project-management",children:"Workspace"})," to collaborate with your team and customize your ",(0,n.jsx)(i.a,{href:"#repository-insights-connecting-your-repositories",children:"Repository Insights"})," and ",(0,n.jsx)(i.a,{href:"#contributor-insights-connecting-with-contributors",children:"Contributor Insights"})," with the repositories you choose and the contributors you want to see."]}),"\n",(0,n.jsx)(i.h2,{id:"getting-started",children:"Getting Started"}),"\n",(0,n.jsxs)(i.p,{children:["To get started, you will need to create an account on OpenSauced. You can do this by visiting the ",(0,n.jsx)(i.a,{href:"https://app.opensauced.pizza",children:"app.opensauced.pizza"}),' and clicking the "Connect with GitHub" button. You will be prompted to sign in with your GitHub account. Once you have signed in, you will be redirected to your Workspace.']}),"\n",(0,n.jsx)(i.h2,{id:"your-workspace-streamlining-open-source-project-management",children:"Your Workspace: Streamlining Open Source Project Management"}),"\n",(0,n.jsx)(i.p,{children:"When you're working with a team, managing multiple projects or even an assortment of repositories within a single project can become overwhelming, especially as you try to keep everyone up-to-date on key information that impacts your projects. Understanding the direction and value of your project can be challenging. To navigate these challenges effectively, you can use Workspaces to:"}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Understand your project at a high level"}),": Being able to look at all your repositories and understand them at a high level makes it easier for you to share this information, collaborate with others, and understand where your projects stand in terms of health."]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Collaborate and create transparency with your team"}),": Understanding the activity for all of your projects equips you to make decisions as a team, set goals for your projects, and understand what brings the most value to those using your project."]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Streamline contributor engagement"}),": Having a high level understanding of your project is a good step in understanding your project\u2019s value, but really understanding what\u2019s happening beneath the surface is the next step in being able to assess project health, growth, and the contributor community."]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Measure and share success"}),": Without insight into your project's activity level, health, and contributor community, it can be a challenge to show the value of your projects. Having real-time analytics on your projects can help you to highlight your key achievements, recognize the impact of your contributors, and communicate the hard work that\u2019s been put into your projects."]}),"\n"]}),"\n",(0,n.jsx)(i.p,{children:"Workspaces is a feature designed to provide maintainers and teams with a centralized platform for organizing, tracking, and analyzing their open source activity. Workspaces gives you a holistic view of project health, team collaboration, and contributor engagement."}),"\n",(0,n.jsx)(i.h3,{id:"creating-a-new-workspace",children:"Creating a New Workspace"}),"\n",(0,n.jsxs)(i.p,{children:["To create a workspace, start by accessing the ",(0,n.jsx)(i.strong,{children:"Workspace switcher"})," in the sidebar. From there, you can create a new workspace or view an existing one."]}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.img,{alt:"workspace switcher",src:t(8164).A+"",width:"1877",height:"888"})}),"\n",(0,n.jsx)("br",{}),"\n",(0,n.jsx)(i.admonition,{type:"note",children:(0,n.jsx)(i.p,{children:'Whenever you select "Home", you\'ll be taken to the last workspace you opened.'})}),"\n",(0,n.jsx)(i.h3,{id:"adding-repositories-to-your-workspace",children:"Adding Repositories to Your Workspace"}),"\n",(0,n.jsx)(i.p,{children:"If you're creating a new workspace, you'll have the option to add repositories at the time of creation."}),"\n",(0,n.jsx)(i.p,{children:'Start by creating a workspace name, then click "Add repositories." You\'ll have three options for adding repositories:'}),"\n",(0,n.jsxs)(i.ol,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Search for Repositories"}),": Use our search tool by adding an organization name, followed by the repository name, and add them to your workspace."]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Import a GitHub Organization"}),": Connect to your GitHub organizations to create a workspace from an organization. (If you're having trouble with this, see the \"",(0,n.jsx)(i.a,{href:"/welcome/faqs#sync-your-github-team",children:"Sync Your GitHub Team"}),'" section in our FAQs.)']}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Import Repositories"}),": Paste a list of repositories to add to your workspace."]}),"\n"]}),"\n",(0,n.jsx)(i.p,{children:"Once your repositories are added, you'll be able to see them in your repository dashboard. You can also edit your workspace to add or remove repositories anytime."}),"\n",(0,n.jsx)(i.h3,{id:"navigating-your-workspace",children:"Navigating Your Workspace"}),"\n",(0,n.jsx)(i.p,{children:"Once your repositories are connected, you'll enter your Workspace dashboard. In your workspace dashboards, you can create, view, and manage your workspaces."}),"\n",(0,n.jsx)(i.h4,{id:"repositories-dashboard",children:"Repositories Dashboard"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.img,{alt:"Workspaces",src:t(389).A+"",width:"3200",height:"1800"})}),"\n",(0,n.jsx)(i.p,{children:"Within the repositories dashboard, you can view the following metrics, which are over a period of thirty days by default:"}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Pull Requests"}),": This includes the total opened and merged pull requests for the repositories included in your workspace, as well as the velocity of pull requests being merged."]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Issues"}),": This includes the total opened and closed issues for the repositories included in your workspace, as well as the velocity of issues being closed."]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Engagement"}),": This includes the total stars, forks, and activity ratio for the repositories included in your workspace."]}),"\n"]}),"\n",(0,n.jsx)(i.p,{children:"Using Workspaces is a new way of approaching open source project management. By centralizing the oversight of your projects and facilitating team collaboration, Workspaces help you to make informed decisions, prioritize effectively, and foster a thriving open source community."}),"\n",(0,n.jsx)(i.p,{children:"Beyond workspaces, you may want to get insights into other repositories and contributors to help you understand the health and growth of your projects. One way to do that is through Repository Insights."}),"\n",(0,n.jsx)(i.h2,{id:"repository-insights-connecting-your-repositories",children:"Repository Insights: Connecting Your Repositories"}),"\n",(0,n.jsx)(i.p,{children:"OpenSauced Repository Insights provides maintainers with a visual representation of their project's health and contributor engagement. It offers real-time data and analytics to understand contribution patterns, identify key contributors, and measure the project's growth. Repository Insights can help you assess team activity, understand when bottlenecks occur, identify where resource allocation is needed, plan and identify key contributors, understand alumni contributors, or spot emerging trends."}),"\n",(0,n.jsx)(i.p,{children:"The Repository Insights feature allows you to:"}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsx)(i.li,{children:"track the contributions of a specific team, a specific repository, or a group of repositories,"}),"\n",(0,n.jsx)(i.li,{children:"view the number of PRs that are open, closed, in draft, and merged,"}),"\n",(0,n.jsx)(i.li,{children:"view the average number of days it takes for a PR to be merged (PR velocity),"}),"\n",(0,n.jsx)(i.li,{children:"identify the top contributors to your project,"}),"\n",(0,n.jsx)(i.li,{children:"identify the current activity level and trends in the activity of your contributors."}),"\n"]}),"\n",(0,n.jsx)(i.h3,{id:"creating-a-new-repository-insight-page",children:"Creating a New Repository Insight Page"}),"\n",(0,n.jsx)(i.p,{children:'To connect and track your repositories, click the "+" next to "Insights" in the sidebar, then select "New Repository Insight." You will be redirected to a page where you can create your new Repository Insight Page.'}),"\n",(0,n.jsx)(i.p,{children:"There are two ways to add repositories to your Repository Insight Page:"}),"\n",(0,n.jsxs)(i.ol,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Sync GitHub organization"}),". Syncing your GitHub organization is a good idea for someone who seeks a comprehensive, unified view of your organization's open source project activities and trends, enabling streamlined management, strategic decision-making, and efficient allocation of resources across multiple repositories."]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Connect individual repositories"}),". Connecting individual repositories is a good idea for someone who wants to track the contributions of a specific repository or group of repositories. For example, you might want to track projects you maintain that are not under the same organization, or you may want to track projects that align with your team's objectives."]}),"\n"]}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.img,{alt:"sync team gif",src:t(6922).A+"",width:"1174",height:"948"})}),"\n",(0,n.jsx)(i.h3,{id:"using-your-repository-insights-page",children:"Using Your Repository Insights Page"}),"\n",(0,n.jsx)(i.p,{children:"Once you have connected your repositories, you will be redirected to your Repository Insight Page. Here, you will see a dashboard with an overview of the repositories and the contributors who have contributed to them."}),"\n",(0,n.jsx)(i.p,{children:"There are three tabs that provide you with more information on these repositories:"}),"\n",(0,n.jsx)(i.h4,{id:"repositories-dashboard-1",children:"Repositories Dashboard"}),"\n",(0,n.jsx)(i.p,{children:"This tab allows you to view more detailed information on each repository, including activity levels, PR overview, PR velocity, spam PRs, contributors, and activity stats over the last 30 days."}),"\n",(0,n.jsx)(i.admonition,{type:"note",children:(0,n.jsxs)(i.p,{children:["To learn and understand more about the data provided, see ",(0,n.jsx)(i.a,{href:"/maintainers/understanding-repo-insights",children:"Understanding Repository Insights Data"}),"."]})}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.img,{alt:"repositories tab",src:t(4394).A+"",width:"1148",height:"796"})}),"\n",(0,n.jsx)(i.h4,{id:"contributors",children:"Contributors"}),"\n",(0,n.jsx)(i.p,{children:'The "Contributors" tab allows you to view more detailed information on each contributor, including their activity levels, the number of repositories they contributed to, the date of their last contribution, their most used language, their time zone, the number of contributions, and their activity stats over the last 30 days.'}),"\n",(0,n.jsxs)(i.p,{children:["You can select and add your contributors to a ",(0,n.jsx)(i.a,{href:"#contributor-insights-connecting-with-contributors",children:"Contributor Insight Page"})," to learn more about them."]}),"\n",(0,n.jsx)(i.p,{children:"There are two ways to add selected contributors to a Contributor Insight Page:"}),"\n",(0,n.jsxs)(i.ol,{children:["\n",(0,n.jsx)(i.li,{children:"Create a new list."}),"\n",(0,n.jsx)(i.li,{children:"Add them to an existing list."}),"\n"]}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.img,{alt:"contributors insight list",src:t(9333).A+"",width:"1212",height:"628"})}),"\n",(0,n.jsx)(i.h4,{id:"activity",children:"Activity"}),"\n",(0,n.jsx)(i.p,{children:"The \"Activity\" tab shows a graph of the last time each contributor created their PR and how many lines of code they've touched. It also provides more detailed information on each contributor when you hover over their image, including their latest PRs and repositories they've contributed to. Clicking their image will bring you to their profile on OpenSauced."}),"\n",(0,n.jsx)(i.p,{children:"You can use the information in this tab to help you learn about their engagement and general interests. It will be helpful if you want to collaborate with them or consider recruiting a maintainer for your project."}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.img,{alt:"activity graph",src:t(3046).A+"",width:"1592",height:"791"})}),"\n",(0,n.jsx)(i.h2,{id:"contributor-insights-connecting-with-contributors",children:"Contributor Insights: Connecting with Contributors"}),"\n",(0,n.jsx)(i.p,{children:"OpenSauced Contributor Insights feature allows you to categorize, monitor, and analyze various groups of contributors. You can use Contributor Insights to track the contributions of a specific team, a specific repository, or a group of repositories. This feature offers granular insights into each contributor's activities and contributions, helping maintainers to track individual contribution histories, identify active engagement, recognize new or alumni contributors, and compare the performance of different contributors."}),"\n",(0,n.jsx)(i.p,{children:"The Contributor Insights features allow you to:"}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsx)(i.li,{children:"track the commits and PRs of the contributors on your list,"}),"\n",(0,n.jsx)(i.li,{children:"filter your contributors by their activity level, including most active, new, and alumni,"}),"\n",(0,n.jsx)(i.li,{children:"view the repositories your contributors have contributed to, the top programming languages they've used, and their time zones."}),"\n"]}),"\n",(0,n.jsx)(i.h3,{id:"why-create-a-contributor-insight-page",children:"Why Create a Contributor Insight Page?"}),"\n",(0,n.jsx)(i.p,{children:"There are many reasons to create a Contributor Insight Page, but here's some inspiration to get you started:"}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Interacting contributors"}),": Keep tabs on contributors actively interacting with your repository."]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Organization's developers"}),": Monitor the contributions and performance of your internal team."]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"VIP contributors"}),": Highlight and track contributors you've identified as key maintainers or significant contributors."]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Sales leads"}),": Identify contributors whose engagement could potentially be turned into sales opportunities."]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Potential hires"}),": Observe contributors who exhibit skill and commitment, making them prime candidates for hiring."]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Alumni contributors"}),": Keep an eye on contributors who have decreased their engagement or left the project."]}),"\n"]}),"\n",(0,n.jsx)(i.h3,{id:"creating-a-new-contributor-insight-page",children:"Creating a New Contributor Insight Page"}),"\n",(0,n.jsxs)(i.ol,{children:["\n",(0,n.jsxs)(i.li,{children:["\n",(0,n.jsx)(i.p,{children:'Click the "+" next to "Insights" in the sidebar.'}),"\n"]}),"\n",(0,n.jsxs)(i.li,{children:["\n",(0,n.jsx)(i.p,{children:'Click "New Contributor Insight." You will be redirected to a page where you can create your new Contributor Insight Page.'}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.img,{alt:"New Contributor Insight Page",src:t(5336).A+"",width:"882",height:"728"})}),"\n"]}),"\n",(0,n.jsxs)(i.li,{children:["\n",(0,n.jsx)(i.p,{children:"Give your page a name."}),"\n"]}),"\n",(0,n.jsxs)(i.li,{children:["\n",(0,n.jsx)(i.p,{children:"Add contributors to your page by searching for their GitHub username, syncing your GitHub Team, or importing your GitHub Following."}),"\n"]}),"\n",(0,n.jsxs)(i.li,{children:["\n",(0,n.jsx)(i.p,{children:"Once your page is created, you can edit and choose to make it public or private. By default, it is set to public. To create a private page, you can upgrade your account to a paid plan."}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.img,{alt:"team sync gif",src:t(7232).A+"",width:"1218",height:"1006"})}),"\n"]}),"\n"]}),"\n",(0,n.jsx)(i.h2,{id:"using-your-contributor-insight-page",children:"Using Your Contributor Insight Page"}),"\n",(0,n.jsx)(i.p,{children:"Once you have created your page, you will be redirected to your Contributor Insight Page. Here, you will see a dashboard with an overview of the contributors."}),"\n",(0,n.jsx)(i.p,{children:"There are three tabs that provide you with more information on these repositories:"}),"\n",(0,n.jsx)(i.h3,{id:"overview",children:"Overview"}),"\n",(0,n.jsxs)(i.p,{children:['The "Overview" tab gives you a high-level view of the contributors in your Contributor Insight Page, including the total number of commits in the last 30 days and the types of contributors: ',(0,n.jsx)(i.a,{href:"/welcome/glossary#active-contributors",children:"Active"}),", ",(0,n.jsx)(i.a,{href:"/welcome/glossary#new-contributors",children:"New"}),", and ",(0,n.jsx)(i.a,{href:"/welcome/glossary#alumni-contributors",children:"Alumni"}),"."]}),"\n",(0,n.jsx)(i.h3,{id:"activity-1",children:"Activity"}),"\n",(0,n.jsx)(i.p,{children:'The "Activity" tab gives you a graph view with more detailed information on each contributor, including the type of activity, repositories they\'ve contributed to, and how they compare to each other.'}),"\n",(0,n.jsx)(i.p,{children:"You can filter your Contributor Insight Page by All Contributors, Active Contributors, New Contributors, and Alumni Contributors."}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.img,{alt:"list graph",src:t(9834).A+"",width:"1263",height:"781"})}),"\n",(0,n.jsx)(i.h3,{id:"highlights",children:"Highlights"}),"\n",(0,n.jsx)(i.p,{children:'The "Highlights" tab gives you a list of the highlights that the contributors listed on your page have created. This is a great way to see what other contributors are up to and to show them support.'}),"\n",(0,n.jsx)(i.admonition,{type:"note",children:(0,n.jsxs)(i.p,{children:["To learn and understand more about the data provided, see ",(0,n.jsx)(i.a,{href:"/maintainers/understanding-contribs-insights",children:"Understanding Contributor Insights Data"}),"."]})}),"\n",(0,n.jsx)(i.h2,{id:"highlights-connecting-and-recognizing-contributions",children:"Highlights: Connecting and Recognizing Contributions"}),"\n",(0,n.jsx)(i.p,{children:"Leveraging OpenSauced's Highlights feature is a great way for maintainers to recognize and showcase the valuable contributions made to your open source projects, curate and share key achievements, contributions, and milestones, and bring visibility to the hard work of your community."}),"\n",(0,n.jsx)(i.p,{children:"Highlights can be used to:"}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsx)(i.li,{children:"publicize issues on your repository that you'd like to match with contributors,"}),"\n",(0,n.jsx)(i.li,{children:"share blog posts you've written,"}),"\n",(0,n.jsx)(i.li,{children:"celebrate PRs for your project."}),"\n"]}),"\n",(0,n.jsx)(i.h3,{id:"creating-a-new-highlight",children:"Creating a New Highlight"}),"\n",(0,n.jsx)(i.p,{children:"There are two ways to create a new highlight:"}),"\n",(0,n.jsxs)(i.ol,{children:["\n",(0,n.jsxs)(i.li,{children:["\n",(0,n.jsx)(i.p,{children:'After clicking the "Highlights" tab in the top navigation, click the input that says "Post a highlight to show your work!"'}),"\n"]}),"\n",(0,n.jsxs)(i.li,{children:["\n",(0,n.jsx)(i.p,{children:'From your profile, click the input that says "Post a highlight to show your work!"'}),"\n"]}),"\n"]}),"\n",(0,n.jsx)(i.p,{children:"After you've clicked the input, you'll see a form that allows you to create a new highlight."}),"\n",(0,n.jsx)(i.p,{children:"There are two ways to create a highlight:"}),"\n",(0,n.jsxs)(i.ol,{children:["\n",(0,n.jsx)(i.li,{children:"Paste the URL to your PR, issue, or blog post (shown in blue below)."}),"\n",(0,n.jsx)(i.li,{children:"Choose from a list of suggestions (shown in orange below)."}),"\n"]}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.img,{alt:"highlight suggestions",src:t(7718).A+"",width:"626",height:"633"})}),"\n",(0,n.jsx)(i.admonition,{type:"note",children:(0,n.jsx)(i.p,{children:"If you're adding a blog post, you'll need to associate it to a repository by clicking the \"Add a repo\" button."})}),"\n",(0,n.jsx)(i.p,{children:"Finally, it's time to add the details of your highlight. You can add a description yourself or use the auto-summarize function to generate a description."}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.img,{alt:"gif of creating a highlight",src:t(9001).A+"",width:"2294",height:"1066"})}),"\n",(0,n.jsx)(i.h3,{id:"writing-an-effective-highlight",children:"Writing an Effective Highlight"}),"\n",(0,n.jsx)(i.p,{children:"Writing an effective highlight is key to attracting contributors to your project. Here are some tips to help you write an effective highlight:"}),"\n",(0,n.jsx)(i.h4,{id:"highlighting-issues",children:"Highlighting Issues"}),"\n",(0,n.jsxs)(i.ol,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Focus on the problem solved"}),": Begin by briefly describing the problem or challenge the issue addresses. This sets the context for why it was important."]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Acknowledge contributor(s)"}),": Mention the contributor(s) who reported or worked on the issue, recognizing their effort."]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Impact statement"}),": Explain how resolving this issue benefits the project, such as improving functionality, user experience, or security."]}),"\n"]}),"\n",(0,n.jsx)(i.h4,{id:"highlighting-prs",children:"Highlighting PRs"}),"\n",(0,n.jsxs)(i.ol,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Summarize the changes"}),": Start with a clear summary of what the PR achieves. This could be a new feature, bug fix, or enhancement."]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Credit the contributors"}),": Acknowledge everyone who contributed to the PR, including reviewers."]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Highlight the value"}),": Explain the value of these changes to the project or its users. For instance, how it improves performance, adds a requested feature, or simplifies the codebase."]}),"\n"]}),"\n",(0,n.jsx)(i.h4,{id:"highlighting-blog-posts",children:"Highlighting Blog Posts"}),"\n",(0,n.jsxs)(i.ol,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Capture the essence"}),": Begin with an interesting blog post summary, capturing the main theme or message."]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Discuss the relevance"}),": Explain why this blog post is important for your open source project or community. Is it about a major update, a community event, or sharing best practices?"]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Engage with a call-to-action"}),": Encourage readers to engage with the post, whether by reading, commenting, or sharing their thoughts on the topic."]}),"\n"]})]})}function l(e={}){const{wrapper:i}={...(0,o.R)(),...e.components};return i?(0,n.jsx)(i,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}},9001:(e,i,t)=>{t.d(i,{A:()=>n});const n=t.p+"assets/images/highlight-e3a2da2446fe91467a31d225755bf40a.gif"},6922:(e,i,t)=>{t.d(i,{A:()=>n});const n=t.p+"assets/images/team-sync-insights-d4d7794d5e28b72ffb375595c988cd37.gif"},7232:(e,i,t)=>{t.d(i,{A:()=>n});const n=t.p+"assets/images/team-sync-09e7e2ab7b54fae335f5b4c40cce94b1.gif"},3046:(e,i,t)=>{t.d(i,{A:()=>n});const n=t.p+"assets/images/activity-repos-insights-3734baf3ab38356a4de96d43dde41a3d.png"},5336:(e,i,t)=>{t.d(i,{A:()=>n});const n=t.p+"assets/images/contrib-insight-new-f821e7b17235b6c7ea7d7d1dedf9573b.png"},9333:(e,i,t)=>{t.d(i,{A:()=>n});const n=t.p+"assets/images/contributors-insights-1bc09dd6a32c3a16eba8b63ec351157f.png"},7718:(e,i,t)=>{t.d(i,{A:()=>n});const n=t.p+"assets/images/highlights-fcc750f036bb2ea7c11166c8338d7f6c.png"},9834:(e,i,t)=>{t.d(i,{A:()=>n});const n=t.p+"assets/images/list-graph-e2718b080f8d3af7e28011a6f064f46e.png"},4394:(e,i,t)=>{t.d(i,{A:()=>n});const n=t.p+"assets/images/repos-insights-2db5d8c668cee2f528f47ae986d664c7.png"},8164:(e,i,t)=>{t.d(i,{A:()=>n});const n=t.p+"assets/images/workspace-switcher-b2400ec5c309a762f822268b44779930.png"},389:(e,i,t)=>{t.d(i,{A:()=>n});const n=t.p+"assets/images/workspace-644e59bed496d2a0df7502aaa833129e.png"},8453:(e,i,t)=>{t.d(i,{R:()=>s,x:()=>a});var n=t(6540);const o={},r=n.createContext(o);function s(e){const i=n.useContext(r);return n.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function a(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),n.createElement(r.Provider,{value:i},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/163a28f8.7afac312.js b/assets/js/163a28f8.7afac312.js
deleted file mode 100644
index 78f46817..00000000
--- a/assets/js/163a28f8.7afac312.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunk_open_sauced_docs_opensauced_pizza=self.webpackChunk_open_sauced_docs_opensauced_pizza||[]).push([[4802],{7028:(e,i,t)=>{t.r(i),t.d(i,{assets:()=>c,contentTitle:()=>s,default:()=>l,frontMatter:()=>r,metadata:()=>a,toc:()=>h});var n=t(4848),o=t(8453);const r={id:"maintainers-guide-to-open-sauced",title:"Maintainers Guide to OpenSauced",sidebar_label:"Maintainers Guide to OpenSauced",keywords:["maintainers","guides","open source maintainers guide","open source maintainer","Maintainers Guide to OpenSauced"]},s=void 0,a={id:"maintainers/maintainers-guide-to-open-sauced",title:"Maintainers Guide to OpenSauced",description:"Introduction to OpenSauced for Maintainers",source:"@site/docs/maintainers/maintainers-guide.md",sourceDirName:"maintainers",slug:"/maintainers/maintainers-guide-to-open-sauced",permalink:"/maintainers/maintainers-guide-to-open-sauced",draft:!1,unlisted:!1,editUrl:"https://github.com/open-sauced/docs.opensauced.pizza/edit/main/docs/maintainers/maintainers-guide.md",tags:[],version:"current",lastUpdatedBy:"BekahHW",lastUpdatedAt:171701191e4,frontMatter:{id:"maintainers-guide-to-open-sauced",title:"Maintainers Guide to OpenSauced",sidebar_label:"Maintainers Guide to OpenSauced",keywords:["maintainers","guides","open source maintainers guide","open source maintainer","Maintainers Guide to OpenSauced"]},sidebar:"docs",previous:{title:"Students Guide to OpenSauced",permalink:"/opensauced-guides/students-guide/"},next:{title:"Understanding Repo Insights Data",permalink:"/maintainers/understanding-repo-insights"}},c={},h=[{value:"Introduction to OpenSauced for Maintainers",id:"introduction-to-opensauced-for-maintainers",level:2},{value:"Getting Started",id:"getting-started",level:2},{value:"Your Workspace: Streamlining Open Source Project Management",id:"your-workspace-streamlining-open-source-project-management",level:2},{value:"Creating a New Workspace",id:"creating-a-new-workspace",level:3},{value:"Adding Repositories to Your Workspace",id:"adding-repositories-to-your-workspace",level:3},{value:"Navigating Your Workspace",id:"navigating-your-workspace",level:3},{value:"Repositories Dashboard",id:"repositories-dashboard",level:4},{value:"Repository Insights: Connecting Your Repositories",id:"repository-insights-connecting-your-repositories",level:2},{value:"Creating a New Repository Insight Page",id:"creating-a-new-repository-insight-page",level:3},{value:"Using Your Repository Insights Page",id:"using-your-repository-insights-page",level:3},{value:"Repositories Dashboard",id:"repositories-dashboard-1",level:4},{value:"Contributors",id:"contributors",level:4},{value:"Activity",id:"activity",level:4},{value:"Contributor Insights: Connecting with Contributors",id:"contributor-insights-connecting-with-contributors",level:2},{value:"Why Create a Contributor Insight Page?",id:"why-create-a-contributor-insight-page",level:3},{value:"Creating a New Contributor Insight Page",id:"creating-a-new-contributor-insight-page",level:3},{value:"Using Your Contributor Insight Page",id:"using-your-contributor-insight-page",level:2},{value:"Overview",id:"overview",level:3},{value:"Activity",id:"activity-1",level:3},{value:"Highlights",id:"highlights",level:3},{value:"Highlights: Connecting and Recognizing Contributions",id:"highlights-connecting-and-recognizing-contributions",level:2},{value:"Creating a New Highlight",id:"creating-a-new-highlight",level:3},{value:"Writing an Effective Highlight",id:"writing-an-effective-highlight",level:3},{value:"Highlighting Issues",id:"highlighting-issues",level:4},{value:"Highlighting PRs",id:"highlighting-prs",level:4},{value:"Highlighting Blog Posts",id:"highlighting-blog-posts",level:4}];function d(e){const i={a:"a",admonition:"admonition",h2:"h2",h3:"h3",h4:"h4",img:"img",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(i.h2,{id:"introduction-to-opensauced-for-maintainers",children:"Introduction to OpenSauced for Maintainers"}),"\n",(0,n.jsxs)(i.p,{children:["OpenSauced is a platform dedicated to empowering maintainers and redefining open source contributions. We offer a GitHub-powered dashboard for tracking contributions and gaining insights into your open source projects. You can create a ",(0,n.jsx)(i.a,{href:"#your-workspace-streamlining-open-source-project-management",children:"Workspace"})," to collaborate with your team and customize your ",(0,n.jsx)(i.a,{href:"#repository-insights-connecting-your-repositories",children:"Repository Insights"})," and ",(0,n.jsx)(i.a,{href:"#contributor-insights-connecting-with-contributors",children:"Contributor Insights"})," with the repositories you choose and the contributors you want to see."]}),"\n",(0,n.jsx)(i.h2,{id:"getting-started",children:"Getting Started"}),"\n",(0,n.jsxs)(i.p,{children:["To get started, you will need to create an account on OpenSauced. You can do this by visiting the ",(0,n.jsx)(i.a,{href:"https://app.opensauced.pizza",children:"app.opensauced.pizza"}),' and clicking the "Connect with GitHub" button. You will be prompted to sign in with your GitHub account. Once you have signed in, you will be redirected to your Workspace.']}),"\n",(0,n.jsx)(i.h2,{id:"your-workspace-streamlining-open-source-project-management",children:"Your Workspace: Streamlining Open Source Project Management"}),"\n",(0,n.jsx)(i.p,{children:"When you're working with a team, managing multiple projects or even an assortment of repositories within a single project can become overwhelming, especially as you try to keep everyone up-to-date on key information that impacts your projects. Understanding the direction and value of your project can be challenging. To navigate these challenges effectively, you can use Workspaces to:"}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Understand your project at a high level"}),": Being able to look at all your repositories and understand them at a high level makes it easier for you to share this information, collaborate with others, and understand where your projects stand in terms of health."]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Collaborate and create transparency with your team"}),": Understanding the activity for all of your projects equips you to make decisions as a team, set goals for your projects, and understand what brings the most value to those using your project."]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Streamline contributor engagement"}),": Having a high level understanding of your project is a good step in understanding your project\u2019s value, but really understanding what\u2019s happening beneath the surface is the next step in being able to assess project health, growth, and the contributor community."]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Measure and share success"}),": Without insight into your project's activity level, health, and contributor community, it can be a challenge to show the value of your projects. Having real-time analytics on your projects can help you to highlight your key achievements, recognize the impact of your contributors, and communicate the hard work that\u2019s been put into your projects."]}),"\n"]}),"\n",(0,n.jsx)(i.p,{children:"Workspaces is a feature designed to provide maintainers and teams with a centralized platform for organizing, tracking, and analyzing their open source activity. Workspaces gives you a holistic view of project health, team collaboration, and contributor engagement."}),"\n",(0,n.jsx)(i.h3,{id:"creating-a-new-workspace",children:"Creating a New Workspace"}),"\n",(0,n.jsxs)(i.p,{children:["To create a workspace, start by accessing the ",(0,n.jsx)(i.strong,{children:"Workspace switcher"})," in the sidebar. From there, you can create a new workspace or view an existing one."]}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.img,{alt:"workspace switcher",src:t(8164).A+"",width:"1877",height:"888"})}),"\n",(0,n.jsx)("br",{}),"\n",(0,n.jsx)(i.admonition,{type:"note",children:(0,n.jsx)(i.p,{children:'Whenever you select "Home", you\'ll be taken to the last workspace you opened.'})}),"\n",(0,n.jsx)(i.h3,{id:"adding-repositories-to-your-workspace",children:"Adding Repositories to Your Workspace"}),"\n",(0,n.jsx)(i.p,{children:"If you're creating a new workspace, you'll have the option to add repositories at the time of creation."}),"\n",(0,n.jsx)(i.p,{children:'Start by creating a workspace name, then click "Add repositories." You\'ll have three options for adding repositories:'}),"\n",(0,n.jsxs)(i.ol,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Search for Repositories"}),": Use our search tool by adding an organization name, followed by the repository name, and add them to your workspace."]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Import a GitHub Organization"}),": Connect to your GitHub organizations to create a workspace from an organization. (If you're having trouble with this, see the \"",(0,n.jsx)(i.a,{href:"/welcome/faqs#sync-your-github-team",children:"Sync Your GitHub Team"}),'" section in our FAQs.)']}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Import Repositories"}),": Paste a list of repositories to add to your workspace."]}),"\n"]}),"\n",(0,n.jsx)(i.p,{children:"Once your repositories are added, you'll be able to see them in your repository dashboard. You can also edit your workspace to add or remove repositories anytime."}),"\n",(0,n.jsx)(i.h3,{id:"navigating-your-workspace",children:"Navigating Your Workspace"}),"\n",(0,n.jsx)(i.p,{children:"Once your repositories are connected, you'll enter your Workspace dashboard. In your workspace dashboards, you can create, view, and manage your workspaces."}),"\n",(0,n.jsx)(i.h4,{id:"repositories-dashboard",children:"Repositories Dashboard"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.img,{alt:"Workspaces",src:t(389).A+"",width:"3200",height:"1800"})}),"\n",(0,n.jsx)(i.p,{children:"Within the repositories dashboard, you can view the following metrics, which are over a period of thirty days by default:"}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Pull Requests"}),": This includes the total opened and merged pull requests for the repositories included in your workspace, as well as the velocity of pull requests being merged."]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Issues"}),": This includes the total opened and closed issues for the repositories included in your workspace, as well as the velocity of issues being closed."]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Engagement"}),": This includes the total stars, forks, and activity ratio for the repositories included in your workspace."]}),"\n"]}),"\n",(0,n.jsx)(i.p,{children:"Using Workspaces is a new way of approaching open source project management. By centralizing the oversight of your projects and facilitating team collaboration, Workspaces help you to make informed decisions, prioritize effectively, and foster a thriving open source community."}),"\n",(0,n.jsx)(i.p,{children:"Beyond workspaces, you may want to get insights into other repositories and contributors to help you understand the health and growth of your projects. One way to do that is through Repository Insights."}),"\n",(0,n.jsx)(i.h2,{id:"repository-insights-connecting-your-repositories",children:"Repository Insights: Connecting Your Repositories"}),"\n",(0,n.jsx)(i.p,{children:"OpenSauced Repository Insights provides maintainers with a visual representation of their project's health and contributor engagement. It offers real-time data and analytics to understand contribution patterns, identify key contributors, and measure the project's growth. Repository Insights can help you assess team activity, understand when bottlenecks occur, identify where resource allocation is needed, plan and identify key contributors, understand alumni contributors, or spot emerging trends."}),"\n",(0,n.jsx)(i.p,{children:"The Repository Insights feature allows you to:"}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsx)(i.li,{children:"track the contributions of a specific team, a specific repository, or a group of repositories,"}),"\n",(0,n.jsx)(i.li,{children:"view the number of PRs that are open, closed, in draft, and merged,"}),"\n",(0,n.jsx)(i.li,{children:"view the average number of days it takes for a PR to be merged (PR velocity),"}),"\n",(0,n.jsx)(i.li,{children:"identify the top contributors to your project,"}),"\n",(0,n.jsx)(i.li,{children:"identify the current activity level and trends in the activity of your contributors."}),"\n"]}),"\n",(0,n.jsx)(i.h3,{id:"creating-a-new-repository-insight-page",children:"Creating a New Repository Insight Page"}),"\n",(0,n.jsx)(i.p,{children:'To connect and track your repositories, click the "+" next to "Insights" in the sidebar, then select "New Repository Insight." You will be redirected to a page where you can create your new Repository Insight Page.'}),"\n",(0,n.jsx)(i.p,{children:"There are two ways to add repositories to your Repository Insight Page:"}),"\n",(0,n.jsxs)(i.ol,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Sync GitHub organization"}),". Syncing your GitHub organization is a good idea for someone who seeks a comprehensive, unified view of your organization's open source project activities and trends, enabling streamlined management, strategic decision-making, and efficient allocation of resources across multiple repositories."]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Connect individual repositories"}),". Connecting individual repositories is a good idea for someone who wants to track the contributions of a specific repository or group of repositories. For example, you might want to track projects you maintain that are not under the same organization, or you may want to track projects that align with your team's objectives."]}),"\n"]}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.img,{alt:"sync team gif",src:t(6922).A+"",width:"1174",height:"948"})}),"\n",(0,n.jsx)(i.h3,{id:"using-your-repository-insights-page",children:"Using Your Repository Insights Page"}),"\n",(0,n.jsx)(i.p,{children:"Once you have connected your repositories, you will be redirected to your Repository Insight Page. Here, you will see a dashboard with an overview of the repositories and the contributors who have contributed to them."}),"\n",(0,n.jsx)(i.p,{children:"There are three tabs that provide you with more information on these repositories:"}),"\n",(0,n.jsx)(i.h4,{id:"repositories-dashboard-1",children:"Repositories Dashboard"}),"\n",(0,n.jsx)(i.p,{children:"This tab allows you to view more detailed information on each repository, including activity levels, PR overview, PR velocity, spam PRs, contributors, and activity stats over the last 30 days."}),"\n",(0,n.jsx)(i.admonition,{type:"note",children:(0,n.jsxs)(i.p,{children:["To learn and understand more about the data provided, see ",(0,n.jsx)(i.a,{href:"/maintainers/understanding-repo-insights",children:"Understanding Repository Insights Data"}),"."]})}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.img,{alt:"repositories tab",src:t(4394).A+"",width:"1148",height:"796"})}),"\n",(0,n.jsx)(i.h4,{id:"contributors",children:"Contributors"}),"\n",(0,n.jsx)(i.p,{children:'The "Contributors" tab allows you to view more detailed information on each contributor, including their activity levels, the number of repositories they contributed to, the date of their last contribution, their most used language, their time zone, the number of contributions, and their activity stats over the last 30 days.'}),"\n",(0,n.jsxs)(i.p,{children:["You can select and add your contributors to a ",(0,n.jsx)(i.a,{href:"#contributor-insights-connecting-with-contributors",children:"Contributor Insight Page"})," to learn more about them."]}),"\n",(0,n.jsx)(i.p,{children:"There are two ways to add selected contributors to a Contributor Insight Page:"}),"\n",(0,n.jsxs)(i.ol,{children:["\n",(0,n.jsx)(i.li,{children:"Create a new list."}),"\n",(0,n.jsx)(i.li,{children:"Add them to an existing list."}),"\n"]}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.img,{alt:"contributors insight list",src:t(9333).A+"",width:"1212",height:"628"})}),"\n",(0,n.jsx)(i.h4,{id:"activity",children:"Activity"}),"\n",(0,n.jsx)(i.p,{children:"The \"Activity\" tab shows a graph of the last time each contributor created their PR and how many lines of code they've touched. It also provides more detailed information on each contributor when you hover over their image, including their latest PRs and repositories they've contributed to. Clicking their image will bring you to their profile on OpenSauced."}),"\n",(0,n.jsx)(i.p,{children:"You can use the information in this tab to help you learn about their engagement and general interests. It will be helpful if you want to collaborate with them or consider recruiting a maintainer for your project."}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.img,{alt:"activity graph",src:t(3046).A+"",width:"1592",height:"791"})}),"\n",(0,n.jsx)(i.h2,{id:"contributor-insights-connecting-with-contributors",children:"Contributor Insights: Connecting with Contributors"}),"\n",(0,n.jsx)(i.p,{children:"OpenSauced Contributor Insights feature allows you to categorize, monitor, and analyze various groups of contributors. You can use Contributor Insights to track the contributions of a specific team, a specific repository, or a group of repositories. This feature offers granular insights into each contributor's activities and contributions, helping maintainers to track individual contribution histories, identify active engagement, recognize new or alumni contributors, and compare the performance of different contributors."}),"\n",(0,n.jsx)(i.p,{children:"The Contributor Insights features allow you to:"}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsx)(i.li,{children:"track the commits and PRs of the contributors on your list,"}),"\n",(0,n.jsx)(i.li,{children:"filter your contributors by their activity level, including most active, new, and alumni,"}),"\n",(0,n.jsx)(i.li,{children:"view the repositories your contributors have contributed to, the top programming languages they've used, and their time zones."}),"\n"]}),"\n",(0,n.jsx)(i.h3,{id:"why-create-a-contributor-insight-page",children:"Why Create a Contributor Insight Page?"}),"\n",(0,n.jsx)(i.p,{children:"There are many reasons to create a Contributor Insight Page, but here's some inspiration to get you started:"}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Interacting contributors"}),": Keep tabs on contributors actively interacting with your repository."]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Organization's developers"}),": Monitor the contributions and performance of your internal team."]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"VIP contributors"}),": Highlight and track contributors you've identified as key maintainers or significant contributors."]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Sales leads"}),": Identify contributors whose engagement could potentially be turned into sales opportunities."]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Potential hires"}),": Observe contributors who exhibit skill and commitment, making them prime candidates for hiring."]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Alumni contributors"}),": Keep an eye on contributors who have decreased their engagement or left the project."]}),"\n"]}),"\n",(0,n.jsx)(i.h3,{id:"creating-a-new-contributor-insight-page",children:"Creating a New Contributor Insight Page"}),"\n",(0,n.jsxs)(i.ol,{children:["\n",(0,n.jsxs)(i.li,{children:["\n",(0,n.jsx)(i.p,{children:'Click the "+" next to "Insights" in the sidebar.'}),"\n"]}),"\n",(0,n.jsxs)(i.li,{children:["\n",(0,n.jsx)(i.p,{children:'Click "New Contributor Insight." You will be redirected to a page where you can create your new Contributor Insight Page.'}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.img,{alt:"New Contributor Insight Page",src:t(5336).A+"",width:"882",height:"728"})}),"\n"]}),"\n",(0,n.jsxs)(i.li,{children:["\n",(0,n.jsx)(i.p,{children:"Give your page a name."}),"\n"]}),"\n",(0,n.jsxs)(i.li,{children:["\n",(0,n.jsx)(i.p,{children:"Add contributors to your page by searching for their GitHub username, syncing your GitHub Team, or importing your GitHub Following."}),"\n"]}),"\n",(0,n.jsxs)(i.li,{children:["\n",(0,n.jsx)(i.p,{children:"Once your page is created, you can edit and choose to make it public or private. By default, it is set to public. To create a private page, you can upgrade your account to a paid plan."}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.img,{alt:"team sync gif",src:t(7232).A+"",width:"1218",height:"1006"})}),"\n"]}),"\n"]}),"\n",(0,n.jsx)(i.h2,{id:"using-your-contributor-insight-page",children:"Using Your Contributor Insight Page"}),"\n",(0,n.jsx)(i.p,{children:"Once you have created your page, you will be redirected to your Contributor Insight Page. Here, you will see a dashboard with an overview of the contributors."}),"\n",(0,n.jsx)(i.p,{children:"There are three tabs that provide you with more information on these repositories:"}),"\n",(0,n.jsx)(i.h3,{id:"overview",children:"Overview"}),"\n",(0,n.jsxs)(i.p,{children:['The "Overview" tab gives you a high-level view of the contributors in your Contributor Insight Page, including the total number of commits in the last 30 days and the types of contributors: ',(0,n.jsx)(i.a,{href:"/welcome/glossary#active-contributors",children:"Active"}),", ",(0,n.jsx)(i.a,{href:"/welcome/glossary#new-contributors",children:"New"}),", and ",(0,n.jsx)(i.a,{href:"/welcome/glossary#alumni-contributors",children:"Alumni"}),"."]}),"\n",(0,n.jsx)(i.h3,{id:"activity-1",children:"Activity"}),"\n",(0,n.jsx)(i.p,{children:'The "Activity" tab gives you a graph view with more detailed information on each contributor, including the type of activity, repositories they\'ve contributed to, and how they compare to each other.'}),"\n",(0,n.jsx)(i.p,{children:"You can filter your Contributor Insight Page by All Contributors, Active Contributors, New Contributors, and Alumni Contributors."}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.img,{alt:"list graph",src:t(9834).A+"",width:"1263",height:"781"})}),"\n",(0,n.jsx)(i.h3,{id:"highlights",children:"Highlights"}),"\n",(0,n.jsx)(i.p,{children:'The "Highlights" tab gives you a list of the highlights that the contributors listed on your page have created. This is a great way to see what other contributors are up to and to show them support.'}),"\n",(0,n.jsx)(i.admonition,{type:"note",children:(0,n.jsxs)(i.p,{children:["To learn and understand more about the data provided, see ",(0,n.jsx)(i.a,{href:"/maintainers/understanding-contribs-insights",children:"Understanding Contributor Insights Data"}),"."]})}),"\n",(0,n.jsx)(i.h2,{id:"highlights-connecting-and-recognizing-contributions",children:"Highlights: Connecting and Recognizing Contributions"}),"\n",(0,n.jsx)(i.p,{children:"Leveraging OpenSauced's Highlights feature is a great way for maintainers to recognize and showcase the valuable contributions made to your open source projects, curate and share key achievements, contributions, and milestones, and bring visibility to the hard work of your community."}),"\n",(0,n.jsx)(i.p,{children:"Highlights can be used to:"}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsx)(i.li,{children:"publicize issues on your repository that you'd like to match with contributors,"}),"\n",(0,n.jsx)(i.li,{children:"share blog posts you've written,"}),"\n",(0,n.jsx)(i.li,{children:"celebrate PRs for your project."}),"\n"]}),"\n",(0,n.jsx)(i.h3,{id:"creating-a-new-highlight",children:"Creating a New Highlight"}),"\n",(0,n.jsx)(i.p,{children:"There are two ways to create a new highlight:"}),"\n",(0,n.jsxs)(i.ol,{children:["\n",(0,n.jsxs)(i.li,{children:["\n",(0,n.jsx)(i.p,{children:'After clicking the "Highlights" tab in the top navigation, click the input that says "Post a highlight to show your work!"'}),"\n"]}),"\n",(0,n.jsxs)(i.li,{children:["\n",(0,n.jsx)(i.p,{children:'From your profile, click the input that says "Post a highlight to show your work!"'}),"\n"]}),"\n"]}),"\n",(0,n.jsx)(i.p,{children:"After you've clicked the input, you'll see a form that allows you to create a new highlight."}),"\n",(0,n.jsx)(i.p,{children:"There are two ways to create a highlight:"}),"\n",(0,n.jsxs)(i.ol,{children:["\n",(0,n.jsx)(i.li,{children:"Paste the URL to your PR, issue, or blog post (shown in blue below)."}),"\n",(0,n.jsx)(i.li,{children:"Choose from a list of suggestions (shown in orange below)."}),"\n"]}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.img,{alt:"highlight suggestions",src:t(7718).A+"",width:"626",height:"633"})}),"\n",(0,n.jsx)(i.admonition,{type:"note",children:(0,n.jsx)(i.p,{children:"If you're adding a blog post, you'll need to associate it to a repository by clicking the \"Add a repo\" button."})}),"\n",(0,n.jsx)(i.p,{children:"Finally, it's time to add the details of your highlight. You can add a description yourself or use the auto-summarize function to generate a description."}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.img,{alt:"gif of creating a highlight",src:t(9001).A+"",width:"2294",height:"1066"})}),"\n",(0,n.jsx)(i.h3,{id:"writing-an-effective-highlight",children:"Writing an Effective Highlight"}),"\n",(0,n.jsx)(i.p,{children:"Writing an effective highlight is key to attracting contributors to your project. Here are some tips to help you write an effective highlight:"}),"\n",(0,n.jsx)(i.h4,{id:"highlighting-issues",children:"Highlighting Issues"}),"\n",(0,n.jsxs)(i.ol,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Focus on the problem solved"}),": Begin by briefly describing the problem or challenge the issue addresses. This sets the context for why it was important."]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Acknowledge contributor(s)"}),": Mention the contributor(s) who reported or worked on the issue, recognizing their effort."]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Impact statement"}),": Explain how resolving this issue benefits the project, such as improving functionality, user experience, or security."]}),"\n"]}),"\n",(0,n.jsx)(i.h4,{id:"highlighting-prs",children:"Highlighting PRs"}),"\n",(0,n.jsxs)(i.ol,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Summarize the changes"}),": Start with a clear summary of what the PR achieves. This could be a new feature, bug fix, or enhancement."]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Credit the contributors"}),": Acknowledge everyone who contributed to the PR, including reviewers."]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Highlight the value"}),": Explain the value of these changes to the project or its users. For instance, how it improves performance, adds a requested feature, or simplifies the codebase."]}),"\n"]}),"\n",(0,n.jsx)(i.h4,{id:"highlighting-blog-posts",children:"Highlighting Blog Posts"}),"\n",(0,n.jsxs)(i.ol,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Capture the essence"}),": Begin with an interesting blog post summary, capturing the main theme or message."]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Discuss the relevance"}),": Explain why this blog post is important for your open source project or community. Is it about a major update, a community event, or sharing best practices?"]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Engage with a call-to-action"}),": Encourage readers to engage with the post, whether by reading, commenting, or sharing their thoughts on the topic."]}),"\n"]})]})}function l(e={}){const{wrapper:i}={...(0,o.R)(),...e.components};return i?(0,n.jsx)(i,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}},9001:(e,i,t)=>{t.d(i,{A:()=>n});const n=t.p+"assets/images/highlight-e3a2da2446fe91467a31d225755bf40a.gif"},6922:(e,i,t)=>{t.d(i,{A:()=>n});const n=t.p+"assets/images/team-sync-insights-d4d7794d5e28b72ffb375595c988cd37.gif"},7232:(e,i,t)=>{t.d(i,{A:()=>n});const n=t.p+"assets/images/team-sync-09e7e2ab7b54fae335f5b4c40cce94b1.gif"},3046:(e,i,t)=>{t.d(i,{A:()=>n});const n=t.p+"assets/images/activity-repos-insights-3734baf3ab38356a4de96d43dde41a3d.png"},5336:(e,i,t)=>{t.d(i,{A:()=>n});const n=t.p+"assets/images/contrib-insight-new-f821e7b17235b6c7ea7d7d1dedf9573b.png"},9333:(e,i,t)=>{t.d(i,{A:()=>n});const n=t.p+"assets/images/contributors-insights-1bc09dd6a32c3a16eba8b63ec351157f.png"},7718:(e,i,t)=>{t.d(i,{A:()=>n});const n=t.p+"assets/images/highlights-fcc750f036bb2ea7c11166c8338d7f6c.png"},9834:(e,i,t)=>{t.d(i,{A:()=>n});const n=t.p+"assets/images/list-graph-e2718b080f8d3af7e28011a6f064f46e.png"},4394:(e,i,t)=>{t.d(i,{A:()=>n});const n=t.p+"assets/images/repos-insights-2db5d8c668cee2f528f47ae986d664c7.png"},8164:(e,i,t)=>{t.d(i,{A:()=>n});const n=t.p+"assets/images/workspace-switcher-b2400ec5c309a762f822268b44779930.png"},389:(e,i,t)=>{t.d(i,{A:()=>n});const n=t.p+"assets/images/workspace-644e59bed496d2a0df7502aaa833129e.png"},8453:(e,i,t)=>{t.d(i,{R:()=>s,x:()=>a});var n=t(6540);const o={},r=n.createContext(o);function s(e){const i=n.useContext(r);return n.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function a(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),n.createElement(r.Provider,{value:i},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/19e98a56.ae549875.js b/assets/js/19e98a56.ae549875.js
new file mode 100644
index 00000000..1bfa2172
--- /dev/null
+++ b/assets/js/19e98a56.ae549875.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunk_open_sauced_docs_opensauced_pizza=self.webpackChunk_open_sauced_docs_opensauced_pizza||[]).push([[7339],{3043:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>d,frontMatter:()=>i,metadata:()=>a,toc:()=>h});var r=s(4848),n=s(8453);const i={id:"star-search",title:"Your Copilot for Git History",sidebar_label:"StarSearch",keywords:["contributors","Monitor Contributors","git history","copilot for git history","open source companies","open source contributors","open source maintainers","AI"]},o=void 0,a={id:"features/star-search",title:"Your Copilot for Git History",description:"StarSearch is our AI-powered feature that provides in-depth insights into contributor history and activities, enabling users to query GitHub activities and analytics through natural language. This tool is designed to provide you with insights into GitHub projects and contributions without requiring any coding or complex queries, bringing transparency and a new depth of knowledge about open source projects. It's your copilot for git history.",source:"@site/docs/features/star-search.md",sourceDirName:"features",slug:"/features/star-search",permalink:"/features/star-search",draft:!1,unlisted:!1,editUrl:"https://github.com/open-sauced/docs.opensauced.pizza/edit/main/docs/features/star-search.md",tags:[],version:"current",lastUpdatedBy:"BekahHW",lastUpdatedAt:1717170876e3,frontMatter:{id:"star-search",title:"Your Copilot for Git History",sidebar_label:"StarSearch",keywords:["contributors","Monitor Contributors","git history","copilot for git history","open source companies","open source contributors","open source maintainers","AI"]},sidebar:"docs",previous:{title:"FAQs",permalink:"/welcome/faqs"},next:{title:"Workspaces",permalink:"/features/workspaces"}},c={},h=[{value:"Key Features",id:"key-features",level:2},{value:"What Can You Discover with StarSearch?",id:"what-can-you-discover-with-starsearch",level:3},{value:"Getting Started with StarSearch",id:"getting-started-with-starsearch",level:2},{value:"User Guide",id:"user-guide",level:3},{value:"Basic Queries",id:"basic-queries",level:4},{value:"FAQs",id:"faqs",level:3},{value:"Feedback",id:"feedback",level:2}];function l(e){const t={a:"a",h2:"h2",h3:"h3",h4:"h4",img:"img",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,n.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"StarSearch"})," is our AI-powered feature that provides in-depth insights into contributor history and activities, enabling users to query GitHub activities and analytics through natural language. This tool is designed to provide you with insights into GitHub projects and contributions without requiring any coding or complex queries, bringing transparency and a new depth of knowledge about open source projects. It's your copilot for git history."]}),"\n",(0,r.jsx)(t.h2,{id:"key-features",children:"Key Features"}),"\n",(0,r.jsxs)(t.ul,{children:["\n",(0,r.jsxs)(t.li,{children:[(0,r.jsx)(t.strong,{children:"Real-Time Insights"}),": Access up-to-date information about GitHub contributions, issues, and projects."]}),"\n",(0,r.jsxs)(t.li,{children:[(0,r.jsx)(t.strong,{children:"Conversational Queries"}),": Use natural language to explore GitHub data."]}),"\n",(0,r.jsxs)(t.li,{children:[(0,r.jsx)(t.strong,{children:"Cross-Project Analysis"}),": Identify connections between different projects and technologies."]}),"\n",(0,r.jsxs)(t.li,{children:[(0,r.jsx)(t.strong,{children:"Contributor Discovery"}),": Pinpoint key contributors and the work they've done."]}),"\n"]}),"\n",(0,r.jsx)(t.h3,{id:"what-can-you-discover-with-starsearch",children:"What Can You Discover with StarSearch?"}),"\n",(0,r.jsxs)(t.ul,{children:["\n",(0,r.jsxs)(t.li,{children:[(0,r.jsx)(t.strong,{children:"Contributor Activities"}),": Learn the details of contributions and contributors."]}),"\n",(0,r.jsxs)(t.li,{children:[(0,r.jsx)(t.strong,{children:"Key Contributors"}),": Identify the key contributors to projects and ecosystems and their impact on the projects."]}),"\n",(0,r.jsxs)(t.li,{children:[(0,r.jsx)(t.strong,{children:"Work-Based Connections"}),": Find potential collaborators based on their contributions to specific projects."]}),"\n",(0,r.jsxs)(t.li,{children:[(0,r.jsx)(t.strong,{children:"Hidden Experts"}),": Discover untapped talent in the ecosystem."]}),"\n"]}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.img,{alt:"StarSearch",src:s(6e3).A+"",width:"1440",height:"1101"})}),"\n",(0,r.jsx)(t.h2,{id:"getting-started-with-starsearch",children:"Getting Started with StarSearch"}),"\n",(0,r.jsxs)(t.ol,{children:["\n",(0,r.jsxs)(t.li,{children:["Log in to ",(0,r.jsx)(t.a,{href:"https://app.opensauced.pizza/",children:"Your OpenSauced Account"})]}),"\n",(0,r.jsxs)(t.li,{children:["Navigate to ",(0,r.jsx)(t.a,{href:"https://app.opensauced.pizza/star-search",children:"https://app.opensauced.pizza/star-search"})," or click the StarSearch tab in the sidebar or navigation bar."]}),"\n"]}),"\n",(0,r.jsx)(t.h3,{id:"user-guide",children:"User Guide"}),"\n",(0,r.jsx)(t.h4,{id:"basic-queries",children:"Basic Queries"}),"\n",(0,r.jsxs)(t.ul,{children:["\n",(0,r.jsx)(t.li,{children:"What type of pull requests has {username} worked on?"}),"\n",(0,r.jsx)(t.li,{children:"Who are the best developers that know {technology} and are interested in {technology}?"}),"\n",(0,r.jsx)(t.li,{children:"Who are the most prevalent contributors to the {technology} ecosystem?"}),"\n",(0,r.jsxs)(t.li,{children:["Show me the ",(0,r.jsx)(t.a,{href:"https://docs.opensauced.pizza/welcome/glossary/#lottery-factor",children:"lottery factor"})," for contributors in the {repository} project?"]}),"\n"]}),"\n",(0,r.jsx)(t.h3,{id:"faqs",children:"FAQs"}),"\n",(0,r.jsxs)(t.ul,{children:["\n",(0,r.jsxs)(t.li,{children:[(0,r.jsx)(t.strong,{children:"Can I continue conversations with StarSearch?"}),"\n",(0,r.jsxs)(t.ul,{children:["\n",(0,r.jsx)(t.li,{children:"Not yet, but stay tuned!"}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(t.li,{children:[(0,r.jsx)(t.strong,{children:"Can I access my search history?"}),"\n",(0,r.jsxs)(t.ul,{children:["\n",(0,r.jsx)(t.li,{children:"This feature is currently not available, but we plan to include it in future updates."}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(t.li,{children:[(0,r.jsx)(t.strong,{children:"What time range does StarSearch cover?"}),"\n",(0,r.jsxs)(t.ul,{children:["\n",(0,r.jsx)(t.li,{children:"StarSearch is most accurate from March 1, 2024."}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(t.li,{children:[(0,r.jsx)(t.strong,{children:"Is StarSearch always right?"}),"\n",(0,r.jsxs)(t.ul,{children:["\n",(0,r.jsx)(t.li,{children:"StarSearch is an AI tool and may not always be accurate. We recommend verifying the information."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,r.jsx)(t.h2,{id:"feedback",children:"Feedback"}),"\n",(0,r.jsxs)(t.p,{children:["Your feedback helps us improve StarSearch. If you have any suggestions or questions, please create a ",(0,r.jsx)(t.a,{href:"https://github.com/orgs/open-sauced/discussions/categories/general-feedback-or-bugs",children:"discussion post"})," or open an ",(0,r.jsx)(t.a,{href:"https://github.com/open-sauced/app/issues",children:"issue"}),". You can also use the thumbs-up or thumbs-down buttons on the StarSearch page to let us know if the information was helpful."]})]})}function d(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},6e3:(e,t,s)=>{s.d(t,{A:()=>r});const r=s.p+"assets/images/star-search-fa7ef93cf3fe7556ed2e3d6083d382d7.png"},8453:(e,t,s)=>{s.d(t,{R:()=>o,x:()=>a});var r=s(6540);const n={},i=r.createContext(n);function o(e){const t=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:o(e.components),r.createElement(i.Provider,{value:t},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/19e98a56.f63a378b.js b/assets/js/19e98a56.f63a378b.js
deleted file mode 100644
index 3a5ff802..00000000
--- a/assets/js/19e98a56.f63a378b.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunk_open_sauced_docs_opensauced_pizza=self.webpackChunk_open_sauced_docs_opensauced_pizza||[]).push([[7339],{3043:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>d,frontMatter:()=>i,metadata:()=>a,toc:()=>h});var r=s(4848),n=s(8453);const i={id:"star-search",title:"Your Copilot for Git History",sidebar_label:"StarSearch",keywords:["contributors","Monitor Contributors","git history","copilot for git history","open source companies","open source contributors","open source maintainers","AI"]},o=void 0,a={id:"features/star-search",title:"Your Copilot for Git History",description:"StarSearch is our AI-powered feature that provides in-depth insights into contributor history and activities, enabling users to query GitHub activities and analytics through natural language. This tool is designed to provide you with insights into GitHub projects and contributions without requiring any coding or complex queries, bringing transparency and a new depth of knowledge about open source projects. It's your copilot for git history.",source:"@site/docs/features/star-search.md",sourceDirName:"features",slug:"/features/star-search",permalink:"/features/star-search",draft:!1,unlisted:!1,editUrl:"https://github.com/open-sauced/docs.opensauced.pizza/edit/main/docs/features/star-search.md",tags:[],version:"current",lastUpdatedBy:"BekahHW",lastUpdatedAt:171701191e4,frontMatter:{id:"star-search",title:"Your Copilot for Git History",sidebar_label:"StarSearch",keywords:["contributors","Monitor Contributors","git history","copilot for git history","open source companies","open source contributors","open source maintainers","AI"]},sidebar:"docs",previous:{title:"FAQs",permalink:"/welcome/faqs"},next:{title:"Workspaces",permalink:"/features/workspaces"}},c={},h=[{value:"Key Features",id:"key-features",level:2},{value:"What Can You Discover with StarSearch?",id:"what-can-you-discover-with-starsearch",level:3},{value:"Getting Started with StarSearch",id:"getting-started-with-starsearch",level:2},{value:"User Guide",id:"user-guide",level:3},{value:"Basic Queries",id:"basic-queries",level:4},{value:"FAQs",id:"faqs",level:3},{value:"Feedback",id:"feedback",level:2}];function l(e){const t={a:"a",h2:"h2",h3:"h3",h4:"h4",img:"img",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,n.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"StarSearch"})," is our AI-powered feature that provides in-depth insights into contributor history and activities, enabling users to query GitHub activities and analytics through natural language. This tool is designed to provide you with insights into GitHub projects and contributions without requiring any coding or complex queries, bringing transparency and a new depth of knowledge about open source projects. It's your copilot for git history."]}),"\n",(0,r.jsx)(t.h2,{id:"key-features",children:"Key Features"}),"\n",(0,r.jsxs)(t.ul,{children:["\n",(0,r.jsxs)(t.li,{children:[(0,r.jsx)(t.strong,{children:"Real-Time Insights"}),": Access up-to-date information about GitHub contributions, issues, and projects."]}),"\n",(0,r.jsxs)(t.li,{children:[(0,r.jsx)(t.strong,{children:"Conversational Queries"}),": Use natural language to explore GitHub data."]}),"\n",(0,r.jsxs)(t.li,{children:[(0,r.jsx)(t.strong,{children:"Cross-Project Analysis"}),": Identify connections between different projects and technologies."]}),"\n",(0,r.jsxs)(t.li,{children:[(0,r.jsx)(t.strong,{children:"Contributor Discovery"}),": Pinpoint key contributors and the work they've done."]}),"\n"]}),"\n",(0,r.jsx)(t.h3,{id:"what-can-you-discover-with-starsearch",children:"What Can You Discover with StarSearch?"}),"\n",(0,r.jsxs)(t.ul,{children:["\n",(0,r.jsxs)(t.li,{children:[(0,r.jsx)(t.strong,{children:"Contributor Activities"}),": Learn the details of contributions and contributors."]}),"\n",(0,r.jsxs)(t.li,{children:[(0,r.jsx)(t.strong,{children:"Key Contributors"}),": Identify the key contributors to projects and ecosystems and their impact on the projects."]}),"\n",(0,r.jsxs)(t.li,{children:[(0,r.jsx)(t.strong,{children:"Work-Based Connections"}),": Find potential collaborators based on their contributions to specific projects."]}),"\n",(0,r.jsxs)(t.li,{children:[(0,r.jsx)(t.strong,{children:"Hidden Experts"}),": Discover untapped talent in the ecosystem."]}),"\n"]}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.img,{alt:"StarSearch",src:s(6e3).A+"",width:"1440",height:"1101"})}),"\n",(0,r.jsx)(t.h2,{id:"getting-started-with-starsearch",children:"Getting Started with StarSearch"}),"\n",(0,r.jsxs)(t.ol,{children:["\n",(0,r.jsxs)(t.li,{children:["Log in to ",(0,r.jsx)(t.a,{href:"https://app.opensauced.pizza/",children:"Your OpenSauced Account"})]}),"\n",(0,r.jsxs)(t.li,{children:["Navigate to ",(0,r.jsx)(t.a,{href:"https://app.opensauced.pizza/star-search",children:"https://app.opensauced.pizza/star-search"})," or click the StarSearch tab in the sidebar or navigation bar."]}),"\n"]}),"\n",(0,r.jsx)(t.h3,{id:"user-guide",children:"User Guide"}),"\n",(0,r.jsx)(t.h4,{id:"basic-queries",children:"Basic Queries"}),"\n",(0,r.jsxs)(t.ul,{children:["\n",(0,r.jsx)(t.li,{children:"What type of pull requests has {username} worked on?"}),"\n",(0,r.jsx)(t.li,{children:"Who are the best developers that know {technology} and are interested in {technology}?"}),"\n",(0,r.jsx)(t.li,{children:"Who are the most prevalent contributors to the {technology} ecosystem?"}),"\n",(0,r.jsxs)(t.li,{children:["Show me the ",(0,r.jsx)(t.a,{href:"https://docs.opensauced.pizza/welcome/glossary/#lottery-factor",children:"lottery factor"})," for contributors in the {repository} project?"]}),"\n"]}),"\n",(0,r.jsx)(t.h3,{id:"faqs",children:"FAQs"}),"\n",(0,r.jsxs)(t.ul,{children:["\n",(0,r.jsxs)(t.li,{children:[(0,r.jsx)(t.strong,{children:"Can I continue conversations with StarSearch?"}),"\n",(0,r.jsxs)(t.ul,{children:["\n",(0,r.jsx)(t.li,{children:"Not yet, but stay tuned!"}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(t.li,{children:[(0,r.jsx)(t.strong,{children:"Can I access my search history?"}),"\n",(0,r.jsxs)(t.ul,{children:["\n",(0,r.jsx)(t.li,{children:"This feature is currently not available, but we plan to include it in future updates."}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(t.li,{children:[(0,r.jsx)(t.strong,{children:"What time range does StarSearch cover?"}),"\n",(0,r.jsxs)(t.ul,{children:["\n",(0,r.jsx)(t.li,{children:"StarSearch is most accurate from March 1, 2024."}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(t.li,{children:[(0,r.jsx)(t.strong,{children:"Is StarSearch always right?"}),"\n",(0,r.jsxs)(t.ul,{children:["\n",(0,r.jsx)(t.li,{children:"StarSearch is an AI tool and may not always be accurate. We recommend verifying the information."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,r.jsx)(t.h2,{id:"feedback",children:"Feedback"}),"\n",(0,r.jsxs)(t.p,{children:["Your feedback helps us improve StarSearch. If you have any suggestions or questions, please create a ",(0,r.jsx)(t.a,{href:"https://github.com/orgs/open-sauced/discussions/categories/general-feedback-or-bugs",children:"discussion post"})," or open an ",(0,r.jsx)(t.a,{href:"https://github.com/open-sauced/app/issues",children:"issue"}),". You can also use the thumbs-up or thumbs-down buttons on the StarSearch page to let us know if the information was helpful."]})]})}function d(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},6e3:(e,t,s)=>{s.d(t,{A:()=>r});const r=s.p+"assets/images/star-search-fa7ef93cf3fe7556ed2e3d6083d382d7.png"},8453:(e,t,s)=>{s.d(t,{R:()=>o,x:()=>a});var r=s(6540);const n={},i=r.createContext(n);function o(e){const t=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:o(e.components),r.createElement(i.Provider,{value:t},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/32aa117d.bae374a2.js b/assets/js/32aa117d.bae374a2.js
deleted file mode 100644
index 0326b41f..00000000
--- a/assets/js/32aa117d.bae374a2.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunk_open_sauced_docs_opensauced_pizza=self.webpackChunk_open_sauced_docs_opensauced_pizza||[]).push([[141],{8476:(e,o,t)=>{t.r(o),t.d(o,{assets:()=>u,contentTitle:()=>r,default:()=>l,frontMatter:()=>s,metadata:()=>a,toc:()=>d});var n=t(4848),i=t(8453);const s={id:"faqs",title:"Frequently Asked Questions",sidebar_label:"FAQs",keywords:["faqs","Frequently asked questions","Popular FAQs guide","most asked questions"]},r=void 0,a={id:"welcome/faqs",title:"Frequently Asked Questions",description:"Contributions",source:"@site/docs/welcome/faqs.md",sourceDirName:"welcome",slug:"/welcome/faqs",permalink:"/welcome/faqs",draft:!1,unlisted:!1,editUrl:"https://github.com/open-sauced/docs.opensauced.pizza/edit/main/docs/welcome/faqs.md",tags:[],version:"current",lastUpdatedBy:"BekahHW",lastUpdatedAt:171701191e4,frontMatter:{id:"faqs",title:"Frequently Asked Questions",sidebar_label:"FAQs",keywords:["faqs","Frequently asked questions","Popular FAQs guide","most asked questions"]},sidebar:"docs",previous:{title:"OpenSauced Glossary",permalink:"/welcome/glossary"},next:{title:"StarSearch",permalink:"/features/star-search"}},u={},d=[{value:"Contributions",id:"contributions",level:2},{value:"1. How do I find good first issues?",id:"1-how-do-i-find-good-first-issues",level:3},{value:"Additional Resources:",id:"additional-resources",level:4},{value:"2. My contribution does not show up on my OpenSauced profile. How do I fix it?",id:"2-my-contribution-does-not-show-up-on-my-opensauced-profile-how-do-i-fix-it",level:3},{value:"3. I want to provide feedback on OpenSauced.",id:"3-i-want-to-provide-feedback-on-opensauced",level:3},{value:"Sync Your GitHub Team",id:"sync-your-github-team",level:2},{value:"1. I don't see my organization on "Sync your GitHub Team."",id:"1-i-dont-see-my-organization-on-sync-your-github-team",level:3},{value:"2. I get an error when I try to select my team in "Sync your GitHub Team."",id:"2-i-get-an-error-when-i-try-to-select-my-team-in-sync-your-github-team",level:3},{value:"3. Do I need to grant authorization to connect GitHub to OpenSauced?",id:"3-do-i-need-to-grant-authorization-to-connect-github-to-opensauced",level:3}];function c(e){const o={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",li:"li",p:"p",strong:"strong",ul:"ul",...(0,i.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(o.h2,{id:"contributions",children:"Contributions"}),"\n",(0,n.jsx)(o.h3,{id:"1-how-do-i-find-good-first-issues",children:"1. How do I find good first issues?"}),"\n",(0,n.jsxs)(o.p,{children:["We believe that ",(0,n.jsx)(o.a,{href:"https://opensauced.pizza/blog/good-first-issues-dont-exist",children:"good first issues don't exist"}),", and the best way to find an issue to work on is to create the issue yourself."]}),"\n",(0,n.jsxs)(o.p,{children:["However, sites like ",(0,n.jsx)(o.a,{href:"https://goodfirstissues.com/",children:"Good First Issues"})," and ",(0,n.jsx)(o.a,{href:"https://www.firsttimersonly.com/",children:"First Timers Only"})," can lead you to projects and issues worth working on. You can also use the ",(0,n.jsx)(o.code,{children:"good first issue"})," label in the project search engine you want to contribute to. Check out ",(0,n.jsx)(o.a,{href:"https://www.freecodecamp.org/news/how-to-find-good-first-issues-on-github/",children:"this guide"})," to learn more about finding a ",(0,n.jsx)(o.code,{children:"good first issue"})," on GitHub.."]}),"\n",(0,n.jsx)(o.h4,{id:"additional-resources",children:"Additional Resources:"}),"\n",(0,n.jsxs)(o.ul,{children:["\n",(0,n.jsx)(o.li,{children:(0,n.jsx)(o.a,{href:"https://dev.to/bekahhw/series/23323",children:'"Who\'s looking for open source contributors?" series on Dev.to'})}),"\n",(0,n.jsx)(o.li,{children:(0,n.jsx)(o.a,{href:"https://intro.opensauced.pizza/",children:"Intro to Open Source Course with OpenSauced"})}),"\n"]}),"\n",(0,n.jsx)(o.h3,{id:"2-my-contribution-does-not-show-up-on-my-opensauced-profile-how-do-i-fix-it",children:"2. My contribution does not show up on my OpenSauced profile. How do I fix it?"}),"\n",(0,n.jsxs)(o.p,{children:["Create a ",(0,n.jsx)(o.a,{href:"https://app.opensauced.pizza/hub/insights",children:"Repository Insights Page"})," or add your merged pull request to a ",(0,n.jsx)(o.a,{href:"https://app.opensauced.pizza/feed",children:"Highlight"}),"."]}),"\n",(0,n.jsx)(o.h3,{id:"3-i-want-to-provide-feedback-on-opensauced",children:"3. I want to provide feedback on OpenSauced."}),"\n",(0,n.jsxs)(o.p,{children:["We love feedback. Post your suggestion in our ",(0,n.jsx)(o.a,{href:"https://github.com/orgs/open-sauced/discussions",children:"feedback repository"}),"."]}),"\n",(0,n.jsx)(o.h2,{id:"sync-your-github-team",children:"Sync Your GitHub Team"}),"\n",(0,n.jsx)(o.h3,{id:"1-i-dont-see-my-organization-on-sync-your-github-team",children:'1. I don\'t see my organization on "Sync your GitHub Team."'}),"\n",(0,n.jsxs)(o.p,{children:['You may not see your organization if you are not a "public" member. You can update this by going to the organization on GitHub and selecting the "People" tab. Next, search for your name. You can then change "private" to "public." For complete instructions, see ',(0,n.jsx)(o.a,{href:"https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/publicizing-or-hiding-organization-membership",children:"this guide"}),"."]}),"\n",(0,n.jsx)(o.h3,{id:"2-i-get-an-error-when-i-try-to-select-my-team-in-sync-your-github-team",children:'2. I get an error when I try to select my team in "Sync your GitHub Team."'}),"\n",(0,n.jsx)(o.p,{children:'If you see your organization but get an error when selecting a team, your organization likely has restricted third-party applications. You can check this if you are an owner by going to "Your organizations" on GitHub, selecting "Settings", and then "Third-party Access."'}),"\n",(0,n.jsxs)(o.p,{children:["If you're an ",(0,n.jsx)(o.strong,{children:"owner"}),' of the repository, you can select "Allow select third-party access" or specifically approve OpenSauced by following the directions in ',(0,n.jsx)(o.a,{href:"https://docs.github.com/en/organizations/managing-oauth-access-to-your-organizations-data/approving-oauth-apps-for-your-organization",children:"this guide"}),"."]}),"\n",(0,n.jsxs)(o.p,{children:["If you are not an owner of the organization, you will need to check with your organization's owner and request access. For complete instructions, see ",(0,n.jsx)(o.a,{href:"https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/requesting-organization-approval-for-oauth-apps",children:"this guide"}),"."]}),"\n",(0,n.jsx)(o.h3,{id:"3-do-i-need-to-grant-authorization-to-connect-github-to-opensauced",children:"3. Do I need to grant authorization to connect GitHub to OpenSauced?"}),"\n",(0,n.jsx)(o.p,{children:"Yes, auth access through GitHub OAuth is required to link your profile to a workspace/team. As an early stage startup, we chose this method for its simplicity. We also request read-only access to your GitHub organizations to gather Contributor Insights based on public GitHub Teams data. We ensure all data used is public and read-only."})]})}function l(e={}){const{wrapper:o}={...(0,i.R)(),...e.components};return o?(0,n.jsx)(o,{...e,children:(0,n.jsx)(c,{...e})}):c(e)}},8453:(e,o,t)=>{t.d(o,{R:()=>r,x:()=>a});var n=t(6540);const i={},s=n.createContext(i);function r(e){const o=n.useContext(s);return n.useMemo((function(){return"function"==typeof e?e(o):{...o,...e}}),[o,e])}function a(e){let o;return o=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),n.createElement(s.Provider,{value:o},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/32aa117d.ff1727b6.js b/assets/js/32aa117d.ff1727b6.js
new file mode 100644
index 00000000..5b10abda
--- /dev/null
+++ b/assets/js/32aa117d.ff1727b6.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunk_open_sauced_docs_opensauced_pizza=self.webpackChunk_open_sauced_docs_opensauced_pizza||[]).push([[141],{8476:(e,o,t)=>{t.r(o),t.d(o,{assets:()=>u,contentTitle:()=>r,default:()=>l,frontMatter:()=>s,metadata:()=>a,toc:()=>d});var n=t(4848),i=t(8453);const s={id:"faqs",title:"Frequently Asked Questions",sidebar_label:"FAQs",keywords:["faqs","Frequently asked questions","Popular FAQs guide","most asked questions"]},r=void 0,a={id:"welcome/faqs",title:"Frequently Asked Questions",description:"Contributions",source:"@site/docs/welcome/faqs.md",sourceDirName:"welcome",slug:"/welcome/faqs",permalink:"/welcome/faqs",draft:!1,unlisted:!1,editUrl:"https://github.com/open-sauced/docs.opensauced.pizza/edit/main/docs/welcome/faqs.md",tags:[],version:"current",lastUpdatedBy:"BekahHW",lastUpdatedAt:1717170876e3,frontMatter:{id:"faqs",title:"Frequently Asked Questions",sidebar_label:"FAQs",keywords:["faqs","Frequently asked questions","Popular FAQs guide","most asked questions"]},sidebar:"docs",previous:{title:"OpenSauced Glossary",permalink:"/welcome/glossary"},next:{title:"StarSearch",permalink:"/features/star-search"}},u={},d=[{value:"Contributions",id:"contributions",level:2},{value:"1. How do I find good first issues?",id:"1-how-do-i-find-good-first-issues",level:3},{value:"Additional Resources:",id:"additional-resources",level:4},{value:"2. My contribution does not show up on my OpenSauced profile. How do I fix it?",id:"2-my-contribution-does-not-show-up-on-my-opensauced-profile-how-do-i-fix-it",level:3},{value:"3. I want to provide feedback on OpenSauced.",id:"3-i-want-to-provide-feedback-on-opensauced",level:3},{value:"Sync Your GitHub Team",id:"sync-your-github-team",level:2},{value:"1. I don't see my organization on "Sync your GitHub Team."",id:"1-i-dont-see-my-organization-on-sync-your-github-team",level:3},{value:"2. I get an error when I try to select my team in "Sync your GitHub Team."",id:"2-i-get-an-error-when-i-try-to-select-my-team-in-sync-your-github-team",level:3},{value:"3. Do I need to grant authorization to connect GitHub to OpenSauced?",id:"3-do-i-need-to-grant-authorization-to-connect-github-to-opensauced",level:3}];function c(e){const o={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",li:"li",p:"p",strong:"strong",ul:"ul",...(0,i.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(o.h2,{id:"contributions",children:"Contributions"}),"\n",(0,n.jsx)(o.h3,{id:"1-how-do-i-find-good-first-issues",children:"1. How do I find good first issues?"}),"\n",(0,n.jsxs)(o.p,{children:["We believe that ",(0,n.jsx)(o.a,{href:"https://opensauced.pizza/blog/good-first-issues-dont-exist",children:"good first issues don't exist"}),", and the best way to find an issue to work on is to create the issue yourself."]}),"\n",(0,n.jsxs)(o.p,{children:["However, sites like ",(0,n.jsx)(o.a,{href:"https://goodfirstissues.com/",children:"Good First Issues"})," and ",(0,n.jsx)(o.a,{href:"https://www.firsttimersonly.com/",children:"First Timers Only"})," can lead you to projects and issues worth working on. You can also use the ",(0,n.jsx)(o.code,{children:"good first issue"})," label in the project search engine you want to contribute to. Check out ",(0,n.jsx)(o.a,{href:"https://www.freecodecamp.org/news/how-to-find-good-first-issues-on-github/",children:"this guide"})," to learn more about finding a ",(0,n.jsx)(o.code,{children:"good first issue"})," on GitHub.."]}),"\n",(0,n.jsx)(o.h4,{id:"additional-resources",children:"Additional Resources:"}),"\n",(0,n.jsxs)(o.ul,{children:["\n",(0,n.jsx)(o.li,{children:(0,n.jsx)(o.a,{href:"https://dev.to/bekahhw/series/23323",children:'"Who\'s looking for open source contributors?" series on Dev.to'})}),"\n",(0,n.jsx)(o.li,{children:(0,n.jsx)(o.a,{href:"https://intro.opensauced.pizza/",children:"Intro to Open Source Course with OpenSauced"})}),"\n"]}),"\n",(0,n.jsx)(o.h3,{id:"2-my-contribution-does-not-show-up-on-my-opensauced-profile-how-do-i-fix-it",children:"2. My contribution does not show up on my OpenSauced profile. How do I fix it?"}),"\n",(0,n.jsxs)(o.p,{children:["Create a ",(0,n.jsx)(o.a,{href:"https://app.opensauced.pizza/hub/insights",children:"Repository Insights Page"})," or add your merged pull request to a ",(0,n.jsx)(o.a,{href:"https://app.opensauced.pizza/feed",children:"Highlight"}),"."]}),"\n",(0,n.jsx)(o.h3,{id:"3-i-want-to-provide-feedback-on-opensauced",children:"3. I want to provide feedback on OpenSauced."}),"\n",(0,n.jsxs)(o.p,{children:["We love feedback. Post your suggestion in our ",(0,n.jsx)(o.a,{href:"https://github.com/orgs/open-sauced/discussions",children:"feedback repository"}),"."]}),"\n",(0,n.jsx)(o.h2,{id:"sync-your-github-team",children:"Sync Your GitHub Team"}),"\n",(0,n.jsx)(o.h3,{id:"1-i-dont-see-my-organization-on-sync-your-github-team",children:'1. I don\'t see my organization on "Sync your GitHub Team."'}),"\n",(0,n.jsxs)(o.p,{children:['You may not see your organization if you are not a "public" member. You can update this by going to the organization on GitHub and selecting the "People" tab. Next, search for your name. You can then change "private" to "public." For complete instructions, see ',(0,n.jsx)(o.a,{href:"https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/publicizing-or-hiding-organization-membership",children:"this guide"}),"."]}),"\n",(0,n.jsx)(o.h3,{id:"2-i-get-an-error-when-i-try-to-select-my-team-in-sync-your-github-team",children:'2. I get an error when I try to select my team in "Sync your GitHub Team."'}),"\n",(0,n.jsx)(o.p,{children:'If you see your organization but get an error when selecting a team, your organization likely has restricted third-party applications. You can check this if you are an owner by going to "Your organizations" on GitHub, selecting "Settings", and then "Third-party Access."'}),"\n",(0,n.jsxs)(o.p,{children:["If you're an ",(0,n.jsx)(o.strong,{children:"owner"}),' of the repository, you can select "Allow select third-party access" or specifically approve OpenSauced by following the directions in ',(0,n.jsx)(o.a,{href:"https://docs.github.com/en/organizations/managing-oauth-access-to-your-organizations-data/approving-oauth-apps-for-your-organization",children:"this guide"}),"."]}),"\n",(0,n.jsxs)(o.p,{children:["If you are not an owner of the organization, you will need to check with your organization's owner and request access. For complete instructions, see ",(0,n.jsx)(o.a,{href:"https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/requesting-organization-approval-for-oauth-apps",children:"this guide"}),"."]}),"\n",(0,n.jsx)(o.h3,{id:"3-do-i-need-to-grant-authorization-to-connect-github-to-opensauced",children:"3. Do I need to grant authorization to connect GitHub to OpenSauced?"}),"\n",(0,n.jsx)(o.p,{children:"Yes, auth access through GitHub OAuth is required to link your profile to a workspace/team. As an early stage startup, we chose this method for its simplicity. We also request read-only access to your GitHub organizations to gather Contributor Insights based on public GitHub Teams data. We ensure all data used is public and read-only."})]})}function l(e={}){const{wrapper:o}={...(0,i.R)(),...e.components};return o?(0,n.jsx)(o,{...e,children:(0,n.jsx)(c,{...e})}):c(e)}},8453:(e,o,t)=>{t.d(o,{R:()=>r,x:()=>a});var n=t(6540);const i={},s=n.createContext(i);function r(e){const o=n.useContext(s);return n.useMemo((function(){return"function"==typeof e?e(o):{...o,...e}}),[o,e])}function a(e){let o;return o=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),n.createElement(s.Provider,{value:o},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/348cc82b.1f965391.js b/assets/js/348cc82b.1f965391.js
new file mode 100644
index 00000000..31b26322
--- /dev/null
+++ b/assets/js/348cc82b.1f965391.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunk_open_sauced_docs_opensauced_pizza=self.webpackChunk_open_sauced_docs_opensauced_pizza||[]).push([[4200],{3918:(e,o,t)=>{t.r(o),t.d(o,{assets:()=>c,contentTitle:()=>r,default:()=>p,frontMatter:()=>n,metadata:()=>a,toc:()=>h});var i=t(4848),s=t(8453);const n={id:"repo-insights",title:"Insights into Open Source Repositories",sidebar_label:"Repository Insights",keywords:["Repository Insights","open source","projects","Open Source Repository Insights","Project Repository Insights","Repository Insights into Open Source Projects","Open Source Project Repository Insights"]},r=void 0,a={id:"features/repo-insights",title:"Insights into Open Source Repositories",description:"The Repository Insights feature is your one-stop solution for understanding the pulse of your open source projects and contributions. This feature is designed to provide a comprehensive view of open source project's health and contributions. From contribution trends to community health, OpenSauced Repository Insights helps you make data-driven decisions that align with your goals. It's not just about numbers; it's about providing data to help you make decisions that can define your approach to open source and tell the story of your project or contribution journey.",source:"@site/docs/features/repo-insights.md",sourceDirName:"features",slug:"/features/repo-insights",permalink:"/features/repo-insights",draft:!1,unlisted:!1,editUrl:"https://github.com/open-sauced/docs.opensauced.pizza/edit/main/docs/features/repo-insights.md",tags:[],version:"current",lastUpdatedBy:"BekahHW",lastUpdatedAt:1717170876e3,frontMatter:{id:"repo-insights",title:"Insights into Open Source Repositories",sidebar_label:"Repository Insights",keywords:["Repository Insights","open source","projects","Open Source Repository Insights","Project Repository Insights","Repository Insights into Open Source Projects","Open Source Project Repository Insights"]},sidebar:"docs",previous:{title:"Workspaces",permalink:"/features/workspaces"},next:{title:"Contributor Insights",permalink:"/features/contributor-insights"}},c={},h=[{value:"How to Use Repository Insights",id:"how-to-use-repository-insights",level:2},{value:"Contributors",id:"contributors",level:3},{value:"Maintainers",id:"maintainers",level:3},{value:"Sharing Your Repository Insights Page with Your Team",id:"sharing-your-repository-insights-page-with-your-team",level:2},{value:"How to Share Repository Insights Page",id:"how-to-share-repository-insights-page",level:3}];function u(e){const o={a:"a",admonition:"admonition",h2:"h2",h3:"h3",img:"img",li:"li",ol:"ol",p:"p",ul:"ul",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(o.p,{children:"The Repository Insights feature is your one-stop solution for understanding the pulse of your open source projects and contributions. This feature is designed to provide a comprehensive view of open source project's health and contributions. From contribution trends to community health, OpenSauced Repository Insights helps you make data-driven decisions that align with your goals. It's not just about numbers; it's about providing data to help you make decisions that can define your approach to open source and tell the story of your project or contribution journey."}),"\n",(0,i.jsx)(o.p,{children:(0,i.jsx)(o.img,{alt:"insight-pages-demo",src:t(709).A+"",width:"960",height:"543"})}),"\n",(0,i.jsx)(o.h2,{id:"how-to-use-repository-insights",children:"How to Use Repository Insights"}),"\n",(0,i.jsx)(o.h3,{id:"contributors",children:"Contributors"}),"\n",(0,i.jsxs)(o.ul,{children:["\n",(0,i.jsx)(o.li,{children:"To track projects you're working on."}),"\n",(0,i.jsx)(o.li,{children:"To identify potential projects to contribute to."}),"\n",(0,i.jsx)(o.li,{children:"To discover other contributors to collaborate with."}),"\n",(0,i.jsx)(o.li,{children:"To track the activity of a topic you're interested in."}),"\n",(0,i.jsx)(o.li,{children:"To track the activity of your favorite programming languages."}),"\n",(0,i.jsx)(o.li,{children:"To aid in the job search process."}),"\n"]}),"\n",(0,i.jsx)(o.admonition,{type:"tip",children:(0,i.jsxs)(o.p,{children:["Check out our ",(0,i.jsx)(o.a,{href:"/contributors/contributors-guide-to-open-sauced#repository-insights-connecting-your-repositories",children:"Contributors Guide to OpenSauced"})," to learn more about how to create and use Repository Insights as a contributor."]})}),"\n",(0,i.jsx)(o.h3,{id:"maintainers",children:"Maintainers"}),"\n",(0,i.jsxs)(o.ul,{children:["\n",(0,i.jsx)(o.li,{children:"To track the health of your project."}),"\n",(0,i.jsx)(o.li,{children:"To identify contributors who are making an impact."}),"\n",(0,i.jsx)(o.li,{children:"To find new contributors to support your project."}),"\n"]}),"\n",(0,i.jsx)(o.admonition,{type:"tip",children:(0,i.jsxs)(o.p,{children:["Check out our ",(0,i.jsx)(o.a,{href:"/maintainers/maintainers-guide-to-open-sauced",children:"Maintainers Guide to OpenSauced"})," and our ",(0,i.jsx)(o.a,{href:"/maintainers/understanding-repo-insights",children:"Understanding Repository Insights Data"})," pages to learn more about how to create and use Repository Insights as a maintainer."]})}),"\n",(0,i.jsx)(o.h2,{id:"sharing-your-repository-insights-page-with-your-team",children:"Sharing Your Repository Insights Page with Your Team"}),"\n",(0,i.jsx)(o.p,{children:"After you've created your Repository Insights Page, share it with your team."}),"\n",(0,i.jsx)(o.p,{children:"Sharing this page with your team ensures that everyone is well-informed about the project's status and can collaborate more effectively. It fosters a collaborative environment where team members can align their efforts, make informed decisions, and collectively work toward the organization's success."}),"\n",(0,i.jsx)(o.h3,{id:"how-to-share-repository-insights-page",children:"How to Share Repository Insights Page"}),"\n",(0,i.jsx)(o.p,{children:"This method gives view-only access to your Repository Insights Page."}),"\n",(0,i.jsxs)(o.ol,{children:["\n",(0,i.jsx)(o.li,{children:"Navigate to your sidebar."}),"\n",(0,i.jsx)(o.li,{children:"Click the Repository Insight Page that you want to share."}),"\n",(0,i.jsx)(o.li,{children:'On the top right, click the "Share" button to copy the Repository Insight Page URL to the clipboard.'}),"\n",(0,i.jsx)(o.li,{children:"Share the URL with your team members."}),"\n"]}),"\n",(0,i.jsx)(o.p,{children:"By default, your Repository Insights are public. If you want to make your Repository Insights private, you can upgrade your account to a PRO plan."})]})}function p(e={}){const{wrapper:o}={...(0,s.R)(),...e.components};return o?(0,i.jsx)(o,{...e,children:(0,i.jsx)(u,{...e})}):u(e)}},709:(e,o,t)=>{t.d(o,{A:()=>i});const i=t.p+"assets/images/insight-page-demo-cc2291df69361b2d476ccffcdbd1ee25.gif"},8453:(e,o,t)=>{t.d(o,{R:()=>r,x:()=>a});var i=t(6540);const s={},n=i.createContext(s);function r(e){const o=i.useContext(n);return i.useMemo((function(){return"function"==typeof e?e(o):{...o,...e}}),[o,e])}function a(e){let o;return o=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),i.createElement(n.Provider,{value:o},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/348cc82b.5181b6ab.js b/assets/js/348cc82b.5181b6ab.js
deleted file mode 100644
index 83840ed7..00000000
--- a/assets/js/348cc82b.5181b6ab.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunk_open_sauced_docs_opensauced_pizza=self.webpackChunk_open_sauced_docs_opensauced_pizza||[]).push([[4200],{3918:(e,o,t)=>{t.r(o),t.d(o,{assets:()=>c,contentTitle:()=>r,default:()=>p,frontMatter:()=>n,metadata:()=>a,toc:()=>h});var i=t(4848),s=t(8453);const n={id:"repo-insights",title:"Insights into Open Source Repositories",sidebar_label:"Repository Insights",keywords:["Repository Insights","open source","projects","Open Source Repository Insights","Project Repository Insights","Repository Insights into Open Source Projects","Open Source Project Repository Insights"]},r=void 0,a={id:"features/repo-insights",title:"Insights into Open Source Repositories",description:"The Repository Insights feature is your one-stop solution for understanding the pulse of your open source projects and contributions. This feature is designed to provide a comprehensive view of open source project's health and contributions. From contribution trends to community health, OpenSauced Repository Insights helps you make data-driven decisions that align with your goals. It's not just about numbers; it's about providing data to help you make decisions that can define your approach to open source and tell the story of your project or contribution journey.",source:"@site/docs/features/repo-insights.md",sourceDirName:"features",slug:"/features/repo-insights",permalink:"/features/repo-insights",draft:!1,unlisted:!1,editUrl:"https://github.com/open-sauced/docs.opensauced.pizza/edit/main/docs/features/repo-insights.md",tags:[],version:"current",lastUpdatedBy:"BekahHW",lastUpdatedAt:171701191e4,frontMatter:{id:"repo-insights",title:"Insights into Open Source Repositories",sidebar_label:"Repository Insights",keywords:["Repository Insights","open source","projects","Open Source Repository Insights","Project Repository Insights","Repository Insights into Open Source Projects","Open Source Project Repository Insights"]},sidebar:"docs",previous:{title:"Workspaces",permalink:"/features/workspaces"},next:{title:"Contributor Insights",permalink:"/features/contributor-insights"}},c={},h=[{value:"How to Use Repository Insights",id:"how-to-use-repository-insights",level:2},{value:"Contributors",id:"contributors",level:3},{value:"Maintainers",id:"maintainers",level:3},{value:"Sharing Your Repository Insights Page with Your Team",id:"sharing-your-repository-insights-page-with-your-team",level:2},{value:"How to Share Repository Insights Page",id:"how-to-share-repository-insights-page",level:3}];function u(e){const o={a:"a",admonition:"admonition",h2:"h2",h3:"h3",img:"img",li:"li",ol:"ol",p:"p",ul:"ul",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(o.p,{children:"The Repository Insights feature is your one-stop solution for understanding the pulse of your open source projects and contributions. This feature is designed to provide a comprehensive view of open source project's health and contributions. From contribution trends to community health, OpenSauced Repository Insights helps you make data-driven decisions that align with your goals. It's not just about numbers; it's about providing data to help you make decisions that can define your approach to open source and tell the story of your project or contribution journey."}),"\n",(0,i.jsx)(o.p,{children:(0,i.jsx)(o.img,{alt:"insight-pages-demo",src:t(709).A+"",width:"960",height:"543"})}),"\n",(0,i.jsx)(o.h2,{id:"how-to-use-repository-insights",children:"How to Use Repository Insights"}),"\n",(0,i.jsx)(o.h3,{id:"contributors",children:"Contributors"}),"\n",(0,i.jsxs)(o.ul,{children:["\n",(0,i.jsx)(o.li,{children:"To track projects you're working on."}),"\n",(0,i.jsx)(o.li,{children:"To identify potential projects to contribute to."}),"\n",(0,i.jsx)(o.li,{children:"To discover other contributors to collaborate with."}),"\n",(0,i.jsx)(o.li,{children:"To track the activity of a topic you're interested in."}),"\n",(0,i.jsx)(o.li,{children:"To track the activity of your favorite programming languages."}),"\n",(0,i.jsx)(o.li,{children:"To aid in the job search process."}),"\n"]}),"\n",(0,i.jsx)(o.admonition,{type:"tip",children:(0,i.jsxs)(o.p,{children:["Check out our ",(0,i.jsx)(o.a,{href:"/contributors/contributors-guide-to-open-sauced#repository-insights-connecting-your-repositories",children:"Contributors Guide to OpenSauced"})," to learn more about how to create and use Repository Insights as a contributor."]})}),"\n",(0,i.jsx)(o.h3,{id:"maintainers",children:"Maintainers"}),"\n",(0,i.jsxs)(o.ul,{children:["\n",(0,i.jsx)(o.li,{children:"To track the health of your project."}),"\n",(0,i.jsx)(o.li,{children:"To identify contributors who are making an impact."}),"\n",(0,i.jsx)(o.li,{children:"To find new contributors to support your project."}),"\n"]}),"\n",(0,i.jsx)(o.admonition,{type:"tip",children:(0,i.jsxs)(o.p,{children:["Check out our ",(0,i.jsx)(o.a,{href:"/maintainers/maintainers-guide-to-open-sauced",children:"Maintainers Guide to OpenSauced"})," and our ",(0,i.jsx)(o.a,{href:"/maintainers/understanding-repo-insights",children:"Understanding Repository Insights Data"})," pages to learn more about how to create and use Repository Insights as a maintainer."]})}),"\n",(0,i.jsx)(o.h2,{id:"sharing-your-repository-insights-page-with-your-team",children:"Sharing Your Repository Insights Page with Your Team"}),"\n",(0,i.jsx)(o.p,{children:"After you've created your Repository Insights Page, share it with your team."}),"\n",(0,i.jsx)(o.p,{children:"Sharing this page with your team ensures that everyone is well-informed about the project's status and can collaborate more effectively. It fosters a collaborative environment where team members can align their efforts, make informed decisions, and collectively work toward the organization's success."}),"\n",(0,i.jsx)(o.h3,{id:"how-to-share-repository-insights-page",children:"How to Share Repository Insights Page"}),"\n",(0,i.jsx)(o.p,{children:"This method gives view-only access to your Repository Insights Page."}),"\n",(0,i.jsxs)(o.ol,{children:["\n",(0,i.jsx)(o.li,{children:"Navigate to your sidebar."}),"\n",(0,i.jsx)(o.li,{children:"Click the Repository Insight Page that you want to share."}),"\n",(0,i.jsx)(o.li,{children:'On the top right, click the "Share" button to copy the Repository Insight Page URL to the clipboard.'}),"\n",(0,i.jsx)(o.li,{children:"Share the URL with your team members."}),"\n"]}),"\n",(0,i.jsx)(o.p,{children:"By default, your Repository Insights are public. If you want to make your Repository Insights private, you can upgrade your account to a PRO plan."})]})}function p(e={}){const{wrapper:o}={...(0,s.R)(),...e.components};return o?(0,i.jsx)(o,{...e,children:(0,i.jsx)(u,{...e})}):u(e)}},709:(e,o,t)=>{t.d(o,{A:()=>i});const i=t.p+"assets/images/insight-page-demo-cc2291df69361b2d476ccffcdbd1ee25.gif"},8453:(e,o,t)=>{t.d(o,{R:()=>r,x:()=>a});var i=t(6540);const s={},n=i.createContext(s);function r(e){const o=i.useContext(n);return i.useMemo((function(){return"function"==typeof e?e(o):{...o,...e}}),[o,e])}function a(e){let o;return o=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),i.createElement(n.Provider,{value:o},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/43ab1095.01c4c303.js b/assets/js/43ab1095.01c4c303.js
deleted file mode 100644
index 1dfafcd3..00000000
--- a/assets/js/43ab1095.01c4c303.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunk_open_sauced_docs_opensauced_pizza=self.webpackChunk_open_sauced_docs_opensauced_pizza||[]).push([[2068],{6748:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>a,frontMatter:()=>i,metadata:()=>l,toc:()=>h});var o=t(4848),s=t(8453);const i={id:"pr-description",title:"PR Description",sidebar_label:"PR Description",keywords:["ai","pr descriptions","pull request overview","pr details","pr review description","Description Guidelines","Contribution etiquette","Pull Request Insight","PR Context","pull request description"]},r=void 0,l={id:"tools/chrome-extension/pr-description",title:"PR Description",description:"The OpenSauced Chrome extension will help you create a PR based on the configuration you have in the extension. It will enable you to create the summary based on either commit messages, the difference between the files, or both. You can even set the message's length and tone using the same settings.",source:"@site/docs/tools/chrome-extension/pr-description.md",sourceDirName:"tools/chrome-extension",slug:"/tools/chrome-extension/pr-description",permalink:"/tools/chrome-extension/pr-description",draft:!1,unlisted:!1,editUrl:"https://github.com/open-sauced/docs.opensauced.pizza/edit/main/docs/tools/chrome-extension/pr-description.md",tags:[],version:"current",lastUpdatedBy:"BekahHW",lastUpdatedAt:171701191e4,frontMatter:{id:"pr-description",title:"PR Description",sidebar_label:"PR Description",keywords:["ai","pr descriptions","pull request overview","pr details","pr review description","Description Guidelines","Contribution etiquette","Pull Request Insight","PR Context","pull request description"]},sidebar:"docs",previous:{title:"Code Explanation",permalink:"/tools/chrome-extension/code-explanation"},next:{title:"Highlight",permalink:"/tools/chrome-extension/highlights"}},c={},h=[];function d(e){const n={a:"a",code:"code",em:"em",img:"img",li:"li",p:"p",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.p,{children:"The OpenSauced Chrome extension will help you create a PR based on the configuration you have in the extension. It will enable you to create the summary based on either commit messages, the difference between the files, or both. You can even set the message's length and tone using the same settings."}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsxs)(n.em,{children:[(0,o.jsx)(n.strong,{children:"Note"}),": This feature is not available on private repositories."]})}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.img,{alt:"generate pr description",src:t(1740).A+"",width:"954",height:"405"})}),"\n",(0,o.jsx)(n.p,{children:"You can use these settings to set the strictness and the tone of the generated AI. Below is the explanation of the settings:"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"Description Length"}),": The output length."]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"Temperature"}),": The similarity between the input text and the output, higher temperature mean more randomness, lower temperature means more strict to the input."]}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.strong,{children:"Max Input Length."})}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"Description Language:"})," Right now, this feature supports: English, Spanish, French, German, Italian, Portuguese, Dutch, Russian, Chinese, Korean."]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"Description Tone:"})," The tone of the output: Exciting, Persuasive, Informative, Humorous, Formal."]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"Description Source:"})," The source of the description that our AI will use to get the output it can be the next: ",(0,o.jsx)(n.strong,{children:"Commit Messages"})," or ",(0,o.jsx)(n.strong,{children:"The diff between the files"})," or ",(0,o.jsx)(n.strong,{children:"both"}),"."]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.img,{src:"https://user-images.githubusercontent.com/18273833/241760972-aa10eabe-3c01-4921-956a-ab85bada1575.png",alt:"Setting screenshot"})}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.img,{src:"https://github.com/open-sauced/docs.opensauced.pizza/assets/18273833/fa19fa8e-e652-461c-8df4-6e959c9b9943",alt:"ezgif-3-43e056fc1f"})}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.a,{href:"https://github.com/open-sauced/insights/pull/1197",children:"Example PR"}),", using the next options: both in the description source, 500 for output length and 3900 max input length, temperature 0.7."]}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"Exciting:"})," This PR fixes the follow call and adds a ",(0,o.jsx)(n.code,{children:"FollowUser"})," function to the ",(0,o.jsx)(n.code,{children:"contributor-highlight-card"}),". The code has been linted and merged from the ",(0,o.jsx)(n.code,{children:"beta"})," branch. ",(0,o.jsx)(n.code,{children:"FollowUser"})," function allows users to follow/unfollow contributors. Copy link and follow/unfollow options are now available in the dropdown menu."]}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"Persuasive:"})," This PR fixes the follow call and linting issues in the ",(0,o.jsx)(n.code,{children:"ContributorHighlightCard"})," component. It also merges the ",(0,o.jsx)(n.code,{children:"beta"})," branch into ",(0,o.jsx)(n.code,{children:"fix-follow-check"}),". A new ",(0,o.jsx)(n.code,{children:"FollowUser"})," function has been added to handle follow/unfollow functionality. This PR ensures a smoother user experience."]}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"Informative:"})," This PR fixes the follow call and linting issues in the ",(0,o.jsx)(n.code,{children:"ContributorHighlightCard"})," component. A new function ",(0,o.jsx)(n.code,{children:"FollowUser"})," has been added to handle the follow/unfollow functionality. The ",(0,o.jsx)(n.code,{children:"useFollowUser"})," hook has been moved inside this function. The ",(0,o.jsx)(n.code,{children:"FollowUser"})," function is now used in place of the previous follow/unfollow code block. The code has been tested and reviewed."]}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"Humorous:"})," This PR fixes the follow call and also lints the file. We've also added a new ",(0,o.jsx)(n.code,{children:"FollowUser"})," function to make the code more readable. Now you can follow/unfollow contributors with ease. We've also merged the ",(0,o.jsx)(n.code,{children:"beta"})," branch into ",(0,o.jsx)(n.code,{children:"fix-follow-check"}),"."]}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"Formal:"})," This PR fixes the follow call and linting issues in the ",(0,o.jsx)(n.code,{children:"ContributorHighlightCard"})," component. A new function ",(0,o.jsx)(n.code,{children:"FollowUser"})," has been added to handle the follow/unfollow functionality. The ",(0,o.jsx)(n.code,{children:"useFollowUser"})," hook has been moved inside this function. The ",(0,o.jsx)(n.code,{children:"FollowUser"})," function is now used in place of the previous follow/unfollow code block. This PR also merges the ",(0,o.jsx)(n.code,{children:"beta"})," branch into ",(0,o.jsx)(n.code,{children:"fix-follow-check"}),"."]})]})}function a(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},1740:(e,n,t)=>{t.d(n,{A:()=>o});const o=t.p+"assets/images/pr-description-e9b163f4d321927a53dd90d340fec85f.gif"},8453:(e,n,t)=>{t.d(n,{R:()=>r,x:()=>l});var o=t(6540);const s={},i=o.createContext(s);function r(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/43ab1095.5d30650f.js b/assets/js/43ab1095.5d30650f.js
new file mode 100644
index 00000000..191436aa
--- /dev/null
+++ b/assets/js/43ab1095.5d30650f.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunk_open_sauced_docs_opensauced_pizza=self.webpackChunk_open_sauced_docs_opensauced_pizza||[]).push([[2068],{6748:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>a,frontMatter:()=>i,metadata:()=>l,toc:()=>h});var o=t(4848),s=t(8453);const i={id:"pr-description",title:"PR Description",sidebar_label:"PR Description",keywords:["ai","pr descriptions","pull request overview","pr details","pr review description","Description Guidelines","Contribution etiquette","Pull Request Insight","PR Context","pull request description"]},r=void 0,l={id:"tools/chrome-extension/pr-description",title:"PR Description",description:"The OpenSauced Chrome extension will help you create a PR based on the configuration you have in the extension. It will enable you to create the summary based on either commit messages, the difference between the files, or both. You can even set the message's length and tone using the same settings.",source:"@site/docs/tools/chrome-extension/pr-description.md",sourceDirName:"tools/chrome-extension",slug:"/tools/chrome-extension/pr-description",permalink:"/tools/chrome-extension/pr-description",draft:!1,unlisted:!1,editUrl:"https://github.com/open-sauced/docs.opensauced.pizza/edit/main/docs/tools/chrome-extension/pr-description.md",tags:[],version:"current",lastUpdatedBy:"BekahHW",lastUpdatedAt:1717170876e3,frontMatter:{id:"pr-description",title:"PR Description",sidebar_label:"PR Description",keywords:["ai","pr descriptions","pull request overview","pr details","pr review description","Description Guidelines","Contribution etiquette","Pull Request Insight","PR Context","pull request description"]},sidebar:"docs",previous:{title:"Code Explanation",permalink:"/tools/chrome-extension/code-explanation"},next:{title:"Highlight",permalink:"/tools/chrome-extension/highlights"}},c={},h=[];function d(e){const n={a:"a",code:"code",em:"em",img:"img",li:"li",p:"p",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.p,{children:"The OpenSauced Chrome extension will help you create a PR based on the configuration you have in the extension. It will enable you to create the summary based on either commit messages, the difference between the files, or both. You can even set the message's length and tone using the same settings."}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsxs)(n.em,{children:[(0,o.jsx)(n.strong,{children:"Note"}),": This feature is not available on private repositories."]})}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.img,{alt:"generate pr description",src:t(1740).A+"",width:"954",height:"405"})}),"\n",(0,o.jsx)(n.p,{children:"You can use these settings to set the strictness and the tone of the generated AI. Below is the explanation of the settings:"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"Description Length"}),": The output length."]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"Temperature"}),": The similarity between the input text and the output, higher temperature mean more randomness, lower temperature means more strict to the input."]}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.strong,{children:"Max Input Length."})}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"Description Language:"})," Right now, this feature supports: English, Spanish, French, German, Italian, Portuguese, Dutch, Russian, Chinese, Korean."]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"Description Tone:"})," The tone of the output: Exciting, Persuasive, Informative, Humorous, Formal."]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"Description Source:"})," The source of the description that our AI will use to get the output it can be the next: ",(0,o.jsx)(n.strong,{children:"Commit Messages"})," or ",(0,o.jsx)(n.strong,{children:"The diff between the files"})," or ",(0,o.jsx)(n.strong,{children:"both"}),"."]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.img,{src:"https://user-images.githubusercontent.com/18273833/241760972-aa10eabe-3c01-4921-956a-ab85bada1575.png",alt:"Setting screenshot"})}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.img,{src:"https://github.com/open-sauced/docs.opensauced.pizza/assets/18273833/fa19fa8e-e652-461c-8df4-6e959c9b9943",alt:"ezgif-3-43e056fc1f"})}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.a,{href:"https://github.com/open-sauced/insights/pull/1197",children:"Example PR"}),", using the next options: both in the description source, 500 for output length and 3900 max input length, temperature 0.7."]}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"Exciting:"})," This PR fixes the follow call and adds a ",(0,o.jsx)(n.code,{children:"FollowUser"})," function to the ",(0,o.jsx)(n.code,{children:"contributor-highlight-card"}),". The code has been linted and merged from the ",(0,o.jsx)(n.code,{children:"beta"})," branch. ",(0,o.jsx)(n.code,{children:"FollowUser"})," function allows users to follow/unfollow contributors. Copy link and follow/unfollow options are now available in the dropdown menu."]}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"Persuasive:"})," This PR fixes the follow call and linting issues in the ",(0,o.jsx)(n.code,{children:"ContributorHighlightCard"})," component. It also merges the ",(0,o.jsx)(n.code,{children:"beta"})," branch into ",(0,o.jsx)(n.code,{children:"fix-follow-check"}),". A new ",(0,o.jsx)(n.code,{children:"FollowUser"})," function has been added to handle follow/unfollow functionality. This PR ensures a smoother user experience."]}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"Informative:"})," This PR fixes the follow call and linting issues in the ",(0,o.jsx)(n.code,{children:"ContributorHighlightCard"})," component. A new function ",(0,o.jsx)(n.code,{children:"FollowUser"})," has been added to handle the follow/unfollow functionality. The ",(0,o.jsx)(n.code,{children:"useFollowUser"})," hook has been moved inside this function. The ",(0,o.jsx)(n.code,{children:"FollowUser"})," function is now used in place of the previous follow/unfollow code block. The code has been tested and reviewed."]}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"Humorous:"})," This PR fixes the follow call and also lints the file. We've also added a new ",(0,o.jsx)(n.code,{children:"FollowUser"})," function to make the code more readable. Now you can follow/unfollow contributors with ease. We've also merged the ",(0,o.jsx)(n.code,{children:"beta"})," branch into ",(0,o.jsx)(n.code,{children:"fix-follow-check"}),"."]}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"Formal:"})," This PR fixes the follow call and linting issues in the ",(0,o.jsx)(n.code,{children:"ContributorHighlightCard"})," component. A new function ",(0,o.jsx)(n.code,{children:"FollowUser"})," has been added to handle the follow/unfollow functionality. The ",(0,o.jsx)(n.code,{children:"useFollowUser"})," hook has been moved inside this function. The ",(0,o.jsx)(n.code,{children:"FollowUser"})," function is now used in place of the previous follow/unfollow code block. This PR also merges the ",(0,o.jsx)(n.code,{children:"beta"})," branch into ",(0,o.jsx)(n.code,{children:"fix-follow-check"}),"."]})]})}function a(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},1740:(e,n,t)=>{t.d(n,{A:()=>o});const o=t.p+"assets/images/pr-description-e9b163f4d321927a53dd90d340fec85f.gif"},8453:(e,n,t)=>{t.d(n,{R:()=>r,x:()=>l});var o=t(6540);const s={},i=o.createContext(s);function r(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/43d9ba09.9925b50f.js b/assets/js/43d9ba09.9925b50f.js
deleted file mode 100644
index 74c68bae..00000000
--- a/assets/js/43d9ba09.9925b50f.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunk_open_sauced_docs_opensauced_pizza=self.webpackChunk_open_sauced_docs_opensauced_pizza||[]).push([[5303],{7534:(e,o,t)=>{t.r(o),t.d(o,{assets:()=>d,contentTitle:()=>s,default:()=>p,frontMatter:()=>a,metadata:()=>r,toc:()=>c});var n=t(4848),i=t(8453);const a={id:"code-explanation",title:"Code Explanation",sidebar_label:"Code Explanation",keywords:["ai","code explanations","Code Interpretation","Programming Insights","Code Understanding","Code Walkthrough","Algorithm Explanation","Software Development Insights","AI in Code"]},s=void 0,r={id:"tools/chrome-extension/code-explanation",title:"Code Explanation",description:"Generate an explanation for a block of code using the blue plus button that is displayed when hovering over a line. To select a block of code, hover over the starting line, click, and drag the blue plus button until you reach the desired line.",source:"@site/docs/tools/chrome-extension/code-explanation.md",sourceDirName:"tools/chrome-extension",slug:"/tools/chrome-extension/code-explanation",permalink:"/tools/chrome-extension/code-explanation",draft:!1,unlisted:!1,editUrl:"https://github.com/open-sauced/docs.opensauced.pizza/edit/main/docs/tools/chrome-extension/code-explanation.md",tags:[],version:"current",lastUpdatedBy:"BekahHW",lastUpdatedAt:171701191e4,frontMatter:{id:"code-explanation",title:"Code Explanation",sidebar_label:"Code Explanation",keywords:["ai","code explanations","Code Interpretation","Programming Insights","Code Understanding","Code Walkthrough","Algorithm Explanation","Software Development Insights","AI in Code"]},sidebar:"docs",previous:{title:"Introduction to the Chrome Extension",permalink:"/tools/chrome-extension/introduction-to-the-chrome-extension"},next:{title:"PR Description",permalink:"/tools/chrome-extension/pr-description"}},d={},c=[];function l(e){const o={img:"img",p:"p",...(0,i.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(o.p,{children:"Generate an explanation for a block of code using the blue plus button that is displayed when hovering over a line. To select a block of code, hover over the starting line, click, and drag the blue plus button until you reach the desired line."}),"\n",(0,n.jsx)(o.p,{children:(0,n.jsx)(o.img,{alt:"generate code refactor",src:t(6067).A+"",width:"828",height:"481"})})]})}function p(e={}){const{wrapper:o}={...(0,i.R)(),...e.components};return o?(0,n.jsx)(o,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},6067:(e,o,t)=>{t.d(o,{A:()=>n});const n=t.p+"assets/images/pr-code-explain-4dde1737ae1b0792fc287750ae7de5fd.gif"},8453:(e,o,t)=>{t.d(o,{R:()=>s,x:()=>r});var n=t(6540);const i={},a=n.createContext(i);function s(e){const o=n.useContext(a);return n.useMemo((function(){return"function"==typeof e?e(o):{...o,...e}}),[o,e])}function r(e){let o;return o=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),n.createElement(a.Provider,{value:o},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/43d9ba09.ebda5300.js b/assets/js/43d9ba09.ebda5300.js
new file mode 100644
index 00000000..8f465a83
--- /dev/null
+++ b/assets/js/43d9ba09.ebda5300.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunk_open_sauced_docs_opensauced_pizza=self.webpackChunk_open_sauced_docs_opensauced_pizza||[]).push([[5303],{7534:(e,o,t)=>{t.r(o),t.d(o,{assets:()=>d,contentTitle:()=>s,default:()=>p,frontMatter:()=>a,metadata:()=>r,toc:()=>c});var n=t(4848),i=t(8453);const a={id:"code-explanation",title:"Code Explanation",sidebar_label:"Code Explanation",keywords:["ai","code explanations","Code Interpretation","Programming Insights","Code Understanding","Code Walkthrough","Algorithm Explanation","Software Development Insights","AI in Code"]},s=void 0,r={id:"tools/chrome-extension/code-explanation",title:"Code Explanation",description:"Generate an explanation for a block of code using the blue plus button that is displayed when hovering over a line. To select a block of code, hover over the starting line, click, and drag the blue plus button until you reach the desired line.",source:"@site/docs/tools/chrome-extension/code-explanation.md",sourceDirName:"tools/chrome-extension",slug:"/tools/chrome-extension/code-explanation",permalink:"/tools/chrome-extension/code-explanation",draft:!1,unlisted:!1,editUrl:"https://github.com/open-sauced/docs.opensauced.pizza/edit/main/docs/tools/chrome-extension/code-explanation.md",tags:[],version:"current",lastUpdatedBy:"BekahHW",lastUpdatedAt:1717170876e3,frontMatter:{id:"code-explanation",title:"Code Explanation",sidebar_label:"Code Explanation",keywords:["ai","code explanations","Code Interpretation","Programming Insights","Code Understanding","Code Walkthrough","Algorithm Explanation","Software Development Insights","AI in Code"]},sidebar:"docs",previous:{title:"Introduction to the Chrome Extension",permalink:"/tools/chrome-extension/introduction-to-the-chrome-extension"},next:{title:"PR Description",permalink:"/tools/chrome-extension/pr-description"}},d={},c=[];function l(e){const o={img:"img",p:"p",...(0,i.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(o.p,{children:"Generate an explanation for a block of code using the blue plus button that is displayed when hovering over a line. To select a block of code, hover over the starting line, click, and drag the blue plus button until you reach the desired line."}),"\n",(0,n.jsx)(o.p,{children:(0,n.jsx)(o.img,{alt:"generate code refactor",src:t(6067).A+"",width:"828",height:"481"})})]})}function p(e={}){const{wrapper:o}={...(0,i.R)(),...e.components};return o?(0,n.jsx)(o,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},6067:(e,o,t)=>{t.d(o,{A:()=>n});const n=t.p+"assets/images/pr-code-explain-4dde1737ae1b0792fc287750ae7de5fd.gif"},8453:(e,o,t)=>{t.d(o,{R:()=>s,x:()=>r});var n=t(6540);const i={},a=n.createContext(i);function s(e){const o=n.useContext(a);return n.useMemo((function(){return"function"==typeof e?e(o):{...o,...e}}),[o,e])}function r(e){let o;return o=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),n.createElement(a.Provider,{value:o},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/455b852b.00025c39.js b/assets/js/455b852b.00025c39.js
deleted file mode 100644
index 34abdaea..00000000
--- a/assets/js/455b852b.00025c39.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunk_open_sauced_docs_opensauced_pizza=self.webpackChunk_open_sauced_docs_opensauced_pizza||[]).push([[2206],{1376:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>u,frontMatter:()=>s,metadata:()=>c,toc:()=>a});var t=o(4848),i=o(8453);const s={id:"introduction-to-the-chrome-extension",title:"Introduction to the Chrome Extension",sidebar_label:"Introduction to the Chrome Extension",keywords:["introduction to the chrome extension","Chrome Extension Overview","Browser Extension Introduction","Chrome Add-On Introduction","Extension Development Basics","Getting Started with Chrome Extension","Browser Plugin Introduction","Chrome Web Store Add-On","Extension Development Guide","Chrome Extension Features","Introduction to Browser Extensions","Chrome Extension Fundamentals","Web Browser Plugin Basics"]},r=void 0,c={id:"tools/chrome-extension/introduction-to-the-chrome-extension",title:"Introduction to the Chrome Extension",description:"The OpenSauced Chrome Extension",source:"@site/docs/tools/chrome-extension/introduction-to-the-chrome-extension.md",sourceDirName:"tools/chrome-extension",slug:"/tools/chrome-extension/introduction-to-the-chrome-extension",permalink:"/tools/chrome-extension/introduction-to-the-chrome-extension",draft:!1,unlisted:!1,editUrl:"https://github.com/open-sauced/docs.opensauced.pizza/edit/main/docs/tools/chrome-extension/introduction-to-the-chrome-extension.md",tags:[],version:"current",lastUpdatedBy:"BekahHW",lastUpdatedAt:171701191e4,frontMatter:{id:"introduction-to-the-chrome-extension",title:"Introduction to the Chrome Extension",sidebar_label:"Introduction to the Chrome Extension",keywords:["introduction to the chrome extension","Chrome Extension Overview","Browser Extension Introduction","Chrome Add-On Introduction","Extension Development Basics","Getting Started with Chrome Extension","Browser Plugin Introduction","Chrome Web Store Add-On","Extension Development Guide","Chrome Extension Features","Introduction to Browser Extensions","Chrome Extension Fundamentals","Web Browser Plugin Basics"]},sidebar:"docs",previous:{title:"Pizza CLI",permalink:"/tools/pizza-cli"},next:{title:"Code Explanation",permalink:"/tools/chrome-extension/code-explanation"}},d={},a=[{value:"The OpenSauced Chrome Extension",id:"the-opensauced-chrome-extension",level:2},{value:"Installing the Chrome Extension",id:"installing-the-chrome-extension",level:2}];function h(e){const n={a:"a",h2:"h2",p:"p",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h2,{id:"the-opensauced-chrome-extension",children:"The OpenSauced Chrome Extension"}),"\n",(0,t.jsx)(n.p,{children:"The OpenSauced Chrome extension seamlessly integrates GitHub with the OpenSauced platform. With this extension, you can easily view and discover open-source projects looking for contributions directly from GitHub, making collaboration and contribution easier than ever."}),"\n",(0,t.jsx)(n.h2,{id:"installing-the-chrome-extension",children:"Installing the Chrome Extension"}),"\n",(0,t.jsxs)(n.p,{children:["To install the OpenSauced Chrome extension, navigate to the ",(0,t.jsx)(n.a,{href:"https://chrome.google.com/webstore/detail/opensauced/aebjdjjodmkdnmejakflnfpkadblfmdh",children:"OpenSauced.ai extension on Chrome Web Store"}),' and click the "Add to Chrome" button.']})]})}function u(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(h,{...e})}):h(e)}},8453:(e,n,o)=>{o.d(n,{R:()=>r,x:()=>c});var t=o(6540);const i={},s=t.createContext(i);function r(e){const n=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/455b852b.6dee8f39.js b/assets/js/455b852b.6dee8f39.js
new file mode 100644
index 00000000..4f438936
--- /dev/null
+++ b/assets/js/455b852b.6dee8f39.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunk_open_sauced_docs_opensauced_pizza=self.webpackChunk_open_sauced_docs_opensauced_pizza||[]).push([[2206],{1376:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>u,frontMatter:()=>s,metadata:()=>c,toc:()=>a});var t=o(4848),i=o(8453);const s={id:"introduction-to-the-chrome-extension",title:"Introduction to the Chrome Extension",sidebar_label:"Introduction to the Chrome Extension",keywords:["introduction to the chrome extension","Chrome Extension Overview","Browser Extension Introduction","Chrome Add-On Introduction","Extension Development Basics","Getting Started with Chrome Extension","Browser Plugin Introduction","Chrome Web Store Add-On","Extension Development Guide","Chrome Extension Features","Introduction to Browser Extensions","Chrome Extension Fundamentals","Web Browser Plugin Basics"]},r=void 0,c={id:"tools/chrome-extension/introduction-to-the-chrome-extension",title:"Introduction to the Chrome Extension",description:"The OpenSauced Chrome Extension",source:"@site/docs/tools/chrome-extension/introduction-to-the-chrome-extension.md",sourceDirName:"tools/chrome-extension",slug:"/tools/chrome-extension/introduction-to-the-chrome-extension",permalink:"/tools/chrome-extension/introduction-to-the-chrome-extension",draft:!1,unlisted:!1,editUrl:"https://github.com/open-sauced/docs.opensauced.pizza/edit/main/docs/tools/chrome-extension/introduction-to-the-chrome-extension.md",tags:[],version:"current",lastUpdatedBy:"BekahHW",lastUpdatedAt:1717170876e3,frontMatter:{id:"introduction-to-the-chrome-extension",title:"Introduction to the Chrome Extension",sidebar_label:"Introduction to the Chrome Extension",keywords:["introduction to the chrome extension","Chrome Extension Overview","Browser Extension Introduction","Chrome Add-On Introduction","Extension Development Basics","Getting Started with Chrome Extension","Browser Plugin Introduction","Chrome Web Store Add-On","Extension Development Guide","Chrome Extension Features","Introduction to Browser Extensions","Chrome Extension Fundamentals","Web Browser Plugin Basics"]},sidebar:"docs",previous:{title:"Pizza CLI",permalink:"/tools/pizza-cli"},next:{title:"Code Explanation",permalink:"/tools/chrome-extension/code-explanation"}},d={},a=[{value:"The OpenSauced Chrome Extension",id:"the-opensauced-chrome-extension",level:2},{value:"Installing the Chrome Extension",id:"installing-the-chrome-extension",level:2}];function h(e){const n={a:"a",h2:"h2",p:"p",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h2,{id:"the-opensauced-chrome-extension",children:"The OpenSauced Chrome Extension"}),"\n",(0,t.jsx)(n.p,{children:"The OpenSauced Chrome extension seamlessly integrates GitHub with the OpenSauced platform. With this extension, you can easily view and discover open-source projects looking for contributions directly from GitHub, making collaboration and contribution easier than ever."}),"\n",(0,t.jsx)(n.h2,{id:"installing-the-chrome-extension",children:"Installing the Chrome Extension"}),"\n",(0,t.jsxs)(n.p,{children:["To install the OpenSauced Chrome extension, navigate to the ",(0,t.jsx)(n.a,{href:"https://chrome.google.com/webstore/detail/opensauced/aebjdjjodmkdnmejakflnfpkadblfmdh",children:"OpenSauced.ai extension on Chrome Web Store"}),' and click the "Add to Chrome" button.']})]})}function u(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(h,{...e})}):h(e)}},8453:(e,n,o)=>{o.d(n,{R:()=>r,x:()=>c});var t=o(6540);const i={},s=t.createContext(i);function r(e){const n=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/48b9cea9.40091d6e.js b/assets/js/48b9cea9.40091d6e.js
deleted file mode 100644
index ba960b6e..00000000
--- a/assets/js/48b9cea9.40091d6e.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunk_open_sauced_docs_opensauced_pizza=self.webpackChunk_open_sauced_docs_opensauced_pizza||[]).push([[3798],{4786:(t,e,n)=>{n.r(e),n.d(e,{assets:()=>u,contentTitle:()=>s,default:()=>h,frontMatter:()=>a,metadata:()=>c,toc:()=>r});var i=n(4848),o=n(8453);const a={id:"set-up-authentication",title:"Set Up Authentication",sidebar_label:"Set Up Authentication",keywords:["set up authentication","Authentication setup guide","Setting up secure login","User authentication configuration","Authentication system setup","Authentication implementation steps","Authentication setup tutorial","Setting up user authorization","Authentication best practices"]},s=void 0,c={id:"contributing/set-up-authentication",title:"Set Up Authentication",description:"You need to obtain an authentication token to interact with the OpenSauced public API as an authenticated user.",source:"@site/docs/contributing/set-up-authentication.md",sourceDirName:"contributing",slug:"/contributing/set-up-authentication",permalink:"/contributing/set-up-authentication",draft:!1,unlisted:!1,editUrl:"https://github.com/open-sauced/docs.opensauced.pizza/edit/main/docs/contributing/set-up-authentication.md",tags:[],version:"current",lastUpdatedBy:"BekahHW",lastUpdatedAt:171701191e4,frontMatter:{id:"set-up-authentication",title:"Set Up Authentication",sidebar_label:"Set Up Authentication",keywords:["set up authentication","Authentication setup guide","Setting up secure login","User authentication configuration","Authentication system setup","Authentication implementation steps","Authentication setup tutorial","Setting up user authorization","Authentication best practices"]},sidebar:"docs",previous:{title:"Community Maintainers Guidelines",permalink:"/contributing/opensauced-maintainers-guide/community-maintainers-guide"},next:{title:"Setting Up a Repository with Git and GitHub",permalink:"/contributing/technical/setup-repo-with-git"}},u={},r=[];function p(t){const e={a:"a",code:"code",img:"img",li:"li",ol:"ol",p:"p",pre:"pre",...(0,o.R)(),...t.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.p,{children:"You need to obtain an authentication token to interact with the OpenSauced public API as an authenticated user."}),"\n",(0,i.jsxs)(e.p,{children:["The following steps outline how to obtain an authentication token from the ",(0,i.jsx)(e.a,{href:"https://hot.opensauced.pizza",children:"hot.opensauced.pizza"})," website:"]}),"\n",(0,i.jsxs)(e.ol,{children:["\n",(0,i.jsxs)(e.li,{children:["\n",(0,i.jsx)(e.p,{children:"Click on your avatar in the top right corner of the page. This will open a dropdown menu."}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.img,{alt:"Avatar in top right corner of the page",src:n(7460).A+"",width:"330",height:"97"})}),"\n"]}),"\n",(0,i.jsxs)(e.li,{children:["\n",(0,i.jsx)(e.p,{children:'Click on the "Copy auth token" option to copy your auth token to clipboard.'}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.img,{alt:"Copy Auth Token",src:n(4500).A+"",width:"347",height:"380"})}),"\n"]}),"\n",(0,i.jsxs)(e.li,{children:["\n",(0,i.jsx)(e.p,{children:"You can now use this token to make authenticated requests to the OpenSauced public API by including it in the Authorization header of your requests. For example:"}),"\n",(0,i.jsx)(e.pre,{children:(0,i.jsx)(e.code,{className:"language-javascript",children:'const response = await fetch(\n "https://api.opensauced.pizza/v2/auth/session",\n {\n method: "GET",\n headers: {\n Authorization: `Bearer ${token}`,\n },\n }\n);\n'})}),"\n"]}),"\n"]})]})}function h(t={}){const{wrapper:e}={...(0,o.R)(),...t.components};return e?(0,i.jsx)(e,{...t,children:(0,i.jsx)(p,{...t})}):p(t)}},7460:(t,e,n)=>{n.d(e,{A:()=>i});const i=n.p+"assets/images/contributing-avatar-top-right-9fa9249bf532c85c0f86a4511ca92110.png"},4500:(t,e,n)=>{n.d(e,{A:()=>i});const i=n.p+"assets/images/contributing-copy-auth-token-41b11f49db098dcbd83cbb5a22952579.png"},8453:(t,e,n)=>{n.d(e,{R:()=>s,x:()=>c});var i=n(6540);const o={},a=i.createContext(o);function s(t){const e=i.useContext(a);return i.useMemo((function(){return"function"==typeof t?t(e):{...e,...t}}),[e,t])}function c(t){let e;return e=t.disableParentContext?"function"==typeof t.components?t.components(o):t.components||o:s(t.components),i.createElement(a.Provider,{value:e},t.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/48b9cea9.a993141b.js b/assets/js/48b9cea9.a993141b.js
new file mode 100644
index 00000000..b363df8f
--- /dev/null
+++ b/assets/js/48b9cea9.a993141b.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunk_open_sauced_docs_opensauced_pizza=self.webpackChunk_open_sauced_docs_opensauced_pizza||[]).push([[3798],{4786:(t,e,n)=>{n.r(e),n.d(e,{assets:()=>u,contentTitle:()=>s,default:()=>h,frontMatter:()=>a,metadata:()=>c,toc:()=>r});var i=n(4848),o=n(8453);const a={id:"set-up-authentication",title:"Set Up Authentication",sidebar_label:"Set Up Authentication",keywords:["set up authentication","Authentication setup guide","Setting up secure login","User authentication configuration","Authentication system setup","Authentication implementation steps","Authentication setup tutorial","Setting up user authorization","Authentication best practices"]},s=void 0,c={id:"contributing/set-up-authentication",title:"Set Up Authentication",description:"You need to obtain an authentication token to interact with the OpenSauced public API as an authenticated user.",source:"@site/docs/contributing/set-up-authentication.md",sourceDirName:"contributing",slug:"/contributing/set-up-authentication",permalink:"/contributing/set-up-authentication",draft:!1,unlisted:!1,editUrl:"https://github.com/open-sauced/docs.opensauced.pizza/edit/main/docs/contributing/set-up-authentication.md",tags:[],version:"current",lastUpdatedBy:"BekahHW",lastUpdatedAt:1717170876e3,frontMatter:{id:"set-up-authentication",title:"Set Up Authentication",sidebar_label:"Set Up Authentication",keywords:["set up authentication","Authentication setup guide","Setting up secure login","User authentication configuration","Authentication system setup","Authentication implementation steps","Authentication setup tutorial","Setting up user authorization","Authentication best practices"]},sidebar:"docs",previous:{title:"Community Maintainers Guidelines",permalink:"/contributing/opensauced-maintainers-guide/community-maintainers-guide"},next:{title:"Setting Up a Repository with Git and GitHub",permalink:"/contributing/technical/setup-repo-with-git"}},u={},r=[];function p(t){const e={a:"a",code:"code",img:"img",li:"li",ol:"ol",p:"p",pre:"pre",...(0,o.R)(),...t.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.p,{children:"You need to obtain an authentication token to interact with the OpenSauced public API as an authenticated user."}),"\n",(0,i.jsxs)(e.p,{children:["The following steps outline how to obtain an authentication token from the ",(0,i.jsx)(e.a,{href:"https://hot.opensauced.pizza",children:"hot.opensauced.pizza"})," website:"]}),"\n",(0,i.jsxs)(e.ol,{children:["\n",(0,i.jsxs)(e.li,{children:["\n",(0,i.jsx)(e.p,{children:"Click on your avatar in the top right corner of the page. This will open a dropdown menu."}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.img,{alt:"Avatar in top right corner of the page",src:n(7460).A+"",width:"330",height:"97"})}),"\n"]}),"\n",(0,i.jsxs)(e.li,{children:["\n",(0,i.jsx)(e.p,{children:'Click on the "Copy auth token" option to copy your auth token to clipboard.'}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.img,{alt:"Copy Auth Token",src:n(4500).A+"",width:"347",height:"380"})}),"\n"]}),"\n",(0,i.jsxs)(e.li,{children:["\n",(0,i.jsx)(e.p,{children:"You can now use this token to make authenticated requests to the OpenSauced public API by including it in the Authorization header of your requests. For example:"}),"\n",(0,i.jsx)(e.pre,{children:(0,i.jsx)(e.code,{className:"language-javascript",children:'const response = await fetch(\n "https://api.opensauced.pizza/v2/auth/session",\n {\n method: "GET",\n headers: {\n Authorization: `Bearer ${token}`,\n },\n }\n);\n'})}),"\n"]}),"\n"]})]})}function h(t={}){const{wrapper:e}={...(0,o.R)(),...t.components};return e?(0,i.jsx)(e,{...t,children:(0,i.jsx)(p,{...t})}):p(t)}},7460:(t,e,n)=>{n.d(e,{A:()=>i});const i=n.p+"assets/images/contributing-avatar-top-right-9fa9249bf532c85c0f86a4511ca92110.png"},4500:(t,e,n)=>{n.d(e,{A:()=>i});const i=n.p+"assets/images/contributing-copy-auth-token-41b11f49db098dcbd83cbb5a22952579.png"},8453:(t,e,n)=>{n.d(e,{R:()=>s,x:()=>c});var i=n(6540);const o={},a=i.createContext(o);function s(t){const e=i.useContext(a);return i.useMemo((function(){return"function"==typeof t?t(e):{...e,...t}}),[e,t])}function c(t){let e;return e=t.disableParentContext?"function"==typeof t.components?t.components(o):t.components||o:s(t.components),i.createElement(a.Provider,{value:e},t.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/4c2521ce.c7e88a93.js b/assets/js/4c2521ce.c7e88a93.js
new file mode 100644
index 00000000..754382e2
--- /dev/null
+++ b/assets/js/4c2521ce.c7e88a93.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunk_open_sauced_docs_opensauced_pizza=self.webpackChunk_open_sauced_docs_opensauced_pizza||[]).push([[5116],{9737:(t,e,i)=>{i.r(e),i.d(e,{assets:()=>l,contentTitle:()=>s,default:()=>u,frontMatter:()=>r,metadata:()=>a,toc:()=>h});var o=i(4848),n=i(8453);const r={id:"setup-repo-with-git",title:"Setting Up a Repository with Git and GitHub",sidebar_label:"Setting Up a Repository with Git and GitHub",keywords:["setting up a repository with Git and GitHub","working with git and github","GitHub repository creation","GitHub repository workflow","GitHub repository initialization","GitHub repository hosting","GitHub repository collaboration","GitHub repository version control","GitHub repository deployment","GitHub repository setup"]},s=void 0,a={id:"contributing/technical/setup-repo-with-git",title:"Setting Up a Repository with Git and GitHub",description:"Using the GitHub CLI",source:"@site/docs/contributing/technical/setup-repo-with-git.md",sourceDirName:"contributing/technical",slug:"/contributing/technical/setup-repo-with-git",permalink:"/contributing/technical/setup-repo-with-git",draft:!1,unlisted:!1,editUrl:"https://github.com/open-sauced/docs.opensauced.pizza/edit/main/docs/contributing/technical/setup-repo-with-git.md",tags:[],version:"current",lastUpdatedBy:"BekahHW",lastUpdatedAt:1717170876e3,frontMatter:{id:"setup-repo-with-git",title:"Setting Up a Repository with Git and GitHub",sidebar_label:"Setting Up a Repository with Git and GitHub",keywords:["setting up a repository with Git and GitHub","working with git and github","GitHub repository creation","GitHub repository workflow","GitHub repository initialization","GitHub repository hosting","GitHub repository collaboration","GitHub repository version control","GitHub repository deployment","GitHub repository setup"]},sidebar:"docs",previous:{title:"Set Up Authentication",permalink:"/contributing/set-up-authentication"},next:{title:"Resolve Merge Conflicts",permalink:"/contributing/technical/resolve-merge-conflicts"}},l={},h=[{value:"Using the GitHub CLI",id:"using-the-github-cli",level:2},{value:"How to Install the GitHub CLI",id:"how-to-install-the-github-cli",level:3},{value:"How to Authenticate with the GitHub CLI",id:"how-to-authenticate-with-the-github-cli",level:3},{value:"How to Fork and Clone a Repository with the GitHub CLI",id:"how-to-fork-and-clone-a-repository-with-the-github-cli",level:3},{value:"How to Add a Remote Repository",id:"how-to-add-a-remote-repository",level:3},{value:"How to View the Remote Repositories Locally",id:"how-to-view-the-remote-repositories-locally",level:3},{value:"Using the GitHub Website and the Command Line",id:"using-the-github-website-and-the-command-line",level:2}];function c(t){const e={a:"a",code:"code",h2:"h2",h3:"h3",p:"p",pre:"pre",...(0,n.R)(),...t.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(e.h2,{id:"using-the-github-cli",children:"Using the GitHub CLI"}),"\n",(0,o.jsx)(e.h3,{id:"how-to-install-the-github-cli",children:"How to Install the GitHub CLI"}),"\n",(0,o.jsxs)(e.p,{children:["The ",(0,o.jsx)(e.a,{href:"https://cli.github.com/",children:"GitHub CLI"})," allows you to fork repositories, create issues, pull requests, and more from the command line."]}),"\n",(0,o.jsxs)(e.p,{children:["Follow these ",(0,o.jsx)(e.a,{href:"https://github.com/cli/cli#installation",children:"instructions to install GitHub CLI"})," on Mac, Windows, or Linux."]}),"\n",(0,o.jsx)(e.h3,{id:"how-to-authenticate-with-the-github-cli",children:"How to Authenticate with the GitHub CLI"}),"\n",(0,o.jsx)(e.p,{children:"From the terminal, you will need to authenticate with the GitHub CLI. You can do this by running the following command:"}),"\n",(0,o.jsx)(e.pre,{children:(0,o.jsx)(e.code,{className:"language-shell",children:"gh auth login\n"})}),"\n",(0,o.jsx)(e.p,{children:"Then, follow the prompts to authenticate with the GitHub CLI."}),"\n",(0,o.jsx)(e.h3,{id:"how-to-fork-and-clone-a-repository-with-the-github-cli",children:"How to Fork and Clone a Repository with the GitHub CLI"}),"\n",(0,o.jsx)(e.p,{children:"A fork is a remote copy of a repository, allowing you to experiment freely with changes without affecting the original project."}),"\n",(0,o.jsx)(e.p,{children:"A clone is a local copy of a repository that includes all the files, branches and commits."}),"\n",(0,o.jsx)(e.p,{children:"To fork and clone a repository with the GitHub CLI, run the following command:"}),"\n",(0,o.jsx)(e.pre,{children:(0,o.jsx)(e.code,{className:"language-shell",children:"gh repo fork open-sauced/node and npm Versions",id:"usage-on-an-older-node-and-npm-versions",level:3},{value:"Why Not Use check-engines or engine-strict?",id:"why-not-use-check-engines-or-engine-strict",level:3},{value:"Library Usage",id:"library-usage",level:3},{value:"Contributing",id:"contributing",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h2:"h2",h3:"h3",li:"li",p:"p",pre:"pre",ul:"ul",...(0,i.R)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(n.h2,{id:"description",children:"Description"}),"\n",(0,c.jsxs)(n.p,{children:["The ",(0,c.jsx)(n.code,{children:"npm"})," package ",(0,c.jsx)(n.code,{children:"@open-sauced/check-engines"})," is designed to help contributors install dependencies conforming to the ",(0,c.jsx)(n.code,{children:"engines"})," property in ",(0,c.jsx)(n.code,{children:"package.json"}),"."]}),"\n",(0,c.jsx)(n.h2,{id:"dependencies",children:"Dependencies"}),"\n",(0,c.jsx)(n.p,{children:"This package uses the following modules:"}),"\n",(0,c.jsxs)(n.ul,{children:["\n",(0,c.jsx)(n.li,{children:(0,c.jsx)(n.a,{href:"https://github.com/npm/npm-install-checks",children:"npm-install-checks"})}),"\n"]}),"\n",(0,c.jsx)(n.h2,{id:"installation",children:"Installation"}),"\n",(0,c.jsx)(n.pre,{children:(0,c.jsx)(n.code,{className:"language-shell",children:"npm install --save-dev @open-sauced/check-engines\n"})}),"\n",(0,c.jsxs)(n.p,{children:["Add the verification scripts to your ",(0,c.jsx)(n.code,{children:"scripts"})," section in the ",(0,c.jsx)(n.code,{children:"package.json"})," file:"]}),"\n",(0,c.jsx)(n.pre,{children:(0,c.jsx)(n.code,{className:"language-json",children:'{\n "scripts": {\n "preinstall": "npx @open-sauced/check-engines"\n }\n}\n'})}),"\n",(0,c.jsxs)(n.p,{children:["The reason why we provide ",(0,c.jsx)(n.code,{children:"npx"})," in the ",(0,c.jsx)(n.code,{children:"scripts"})," section is for the people using this as a development enhancement, interactive configurations or trimmed dependency trees, where using ",(0,c.jsx)(n.code,{children:"npx"})," is preferred over installing all the dependencies at once."]}),"\n",(0,c.jsx)(n.h2,{id:"usage",children:"Usage"}),"\n",(0,c.jsx)(n.p,{children:"Use your favorite package manager to install dependencies in your project or, if you set it as a global verification system:"}),"\n",(0,c.jsx)(n.pre,{children:(0,c.jsx)(n.code,{className:"language-json",children:'{\n "scripts": {\n "check-engines": "npx @open-sauced/check-engines"\n "preinstall": "npm run check-engines",\n "prestart": "npm run check-engines"\n }\n}\n'})}),"\n",(0,c.jsx)(n.h2,{id:"advanced-usage",children:"Advanced Usage"}),"\n",(0,c.jsx)(n.p,{children:"If you have an API or any other non-library type of application, you can decouple this package from any install scripts and just use it as a verification:"}),"\n",(0,c.jsx)(n.pre,{children:(0,c.jsx)(n.code,{className:"language-json",children:'{\n "scripts": {\n "check-engines": "npx @open-sauced/check-engines"\n "prestart": "npm run check-engines"\n }\n}\n'})}),"\n",(0,c.jsxs)(n.p,{children:["A more traditional approach not using ",(0,c.jsx)(n.code,{children:"pre"})," or ",(0,c.jsx)(n.code,{children:"post"})," scripts, this example enables the check only for local machine development:"]}),"\n",(0,c.jsx)(n.pre,{children:(0,c.jsx)(n.code,{className:"language-json",children:'{\n "scripts": {\n "check-engines": "npx @open-sauced/check-engines"\n "start": "...",\n "dev": "npm run check-engines && npm start -- --watch"\n }\n}\n'})}),"\n",(0,c.jsx)(n.h2,{id:"faqs",children:"FAQs"}),"\n",(0,c.jsxs)(n.h3,{id:"usage-on-an-older-node-and-npm-versions",children:["Usage on an Older ",(0,c.jsx)(n.code,{children:"node"})," and ",(0,c.jsx)(n.code,{children:"npm"})," Versions"]}),"\n",(0,c.jsxs)(n.p,{children:["Older ",(0,c.jsx)(n.code,{children:"node"})," and ",(0,c.jsx)(n.code,{children:"npm"})," versions won't be able to run this package; depending on the versions, the scripts section could be ignored completely."]}),"\n",(0,c.jsx)(n.p,{children:"If you have that use case, this package is only worth enabling for progressive contributors frequently missing the legacy support of the respective module and forcefully upgrading dependencies - them running newer versions will force the error message and explicitly disable."}),"\n",(0,c.jsxs)(n.h3,{id:"why-not-use-check-engines-or-engine-strict",children:["Why Not Use ",(0,c.jsx)(n.code,{children:"check-engines"})," or ",(0,c.jsx)(n.code,{children:"engine-strict"}),"?"]}),"\n",(0,c.jsxs)(n.p,{children:["As described in the ",(0,c.jsx)(n.code,{children:"npm@6"})," ",(0,c.jsx)(n.a,{href:"https://docs.npmjs.com/cli/v6/configuring-npm/package-json#enginestrict",children:"engine-strict docs"}),":"]}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:["Prior to npm 3.0.0, this feature was used to treat this package as if the user had set ",(0,c.jsx)(n.code,{children:"engine-strict"}),". It is no longer used."]}),"\n"]}),"\n",(0,c.jsxs)(n.p,{children:["In ",(0,c.jsx)(n.code,{children:"npm@6"})," and later, this was re-introduced as a ",(0,c.jsx)(n.a,{href:"https://docs.npmjs.com/cli/v7/using-npm/config#engine-strict",children:"config flag"}),"."]}),"\n",(0,c.jsx)(n.p,{children:"This package is designed with multiple legacy use cases in mind."}),"\n",(0,c.jsx)(n.h3,{id:"library-usage",children:"Library Usage"}),"\n",(0,c.jsxs)(n.p,{children:["If you use this module in a library package, be advised that any ",(0,c.jsx)(n.code,{children:"*install"})," script will run in the parent module when installed."]}),"\n",(0,c.jsxs)(n.p,{children:["For example, given a module ",(0,c.jsx)(n.code,{children:"@demo-org/demo-package"})," with a ",(0,c.jsx)(n.code,{children:'preinstall: "npx @open-sauced/check-engines"'})," script, running ",(0,c.jsx)(n.code,{children:"npm install @demo-org/demo-package"})," will require your locally installed ",(0,c.jsx)(n.code,{children:"node"})," and ",(0,c.jsx)(n.code,{children:"npm"})," versions to match the ",(0,c.jsx)(n.code,{children:"engines"})," section of your ",(0,c.jsx)(n.code,{children:"package.json"}),". If that is not set, nothing should happen, and this package is a stray dependency in either ",(0,c.jsx)(n.code,{children:"@demo-org/demo-package"})," or the module you are running this command in."]}),"\n",(0,c.jsx)(n.h2,{id:"contributing",children:"Contributing"}),"\n",(0,c.jsx)(n.p,{children:"We're always happy to onboard people into open source!"}),"\n",(0,c.jsxs)(n.p,{children:["Check out the repository at ",(0,c.jsx)(n.a,{href:"https://github.com/open-sauced/check-engines",children:"@open-sauced/check-engines"}),". \u2764\ufe0f"]})]})}function h(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,c.jsx)(n,{...e,children:(0,c.jsx)(l,{...e})}):l(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>a,x:()=>d});var c=s(6540);const i={},o=c.createContext(i);function a(e){const n=c.useContext(o);return c.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:a(e.components),c.createElement(o.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/51fe39eb.a82b241b.js b/assets/js/51fe39eb.a82b241b.js
deleted file mode 100644
index b4f7a844..00000000
--- a/assets/js/51fe39eb.a82b241b.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunk_open_sauced_docs_opensauced_pizza=self.webpackChunk_open_sauced_docs_opensauced_pizza||[]).push([[8167],{4642:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>r,contentTitle:()=>a,default:()=>h,frontMatter:()=>o,metadata:()=>d,toc:()=>t});var c=s(4848),i=s(8453);const o={id:"check-engines",title:"@open-sauced/check-engines",sidebar_label:"@open-sauced/check-engines",keywords:["check engines"]},a=void 0,d={id:"opensauced-packages/check-engines",title:"@open-sauced/check-engines",description:"Description",source:"@site/docs/opensauced-packages/check-engines.md",sourceDirName:"opensauced-packages",slug:"/opensauced-packages/check-engines",permalink:"/opensauced-packages/check-engines",draft:!1,unlisted:!1,editUrl:"https://github.com/open-sauced/docs.opensauced.pizza/edit/main/docs/opensauced-packages/check-engines.md",tags:[],version:"current",lastUpdatedBy:"BekahHW",lastUpdatedAt:171701191e4,frontMatter:{id:"check-engines",title:"@open-sauced/check-engines",sidebar_label:"@open-sauced/check-engines",keywords:["check engines"]},sidebar:"docs",previous:{title:"Resolve Merge Conflicts",permalink:"/contributing/technical/resolve-merge-conflicts"},next:{title:"@open-sauced/conventional-commit",permalink:"/opensauced-packages/conventional-commit"}},r={},t=[{value:"Description",id:"description",level:2},{value:"Dependencies",id:"dependencies",level:2},{value:"Installation",id:"installation",level:2},{value:"Usage",id:"usage",level:2},{value:"Advanced Usage",id:"advanced-usage",level:2},{value:"FAQs",id:"faqs",level:2},{value:"Usage on an Older node and npm Versions",id:"usage-on-an-older-node-and-npm-versions",level:3},{value:"Why Not Use check-engines or engine-strict?",id:"why-not-use-check-engines-or-engine-strict",level:3},{value:"Library Usage",id:"library-usage",level:3},{value:"Contributing",id:"contributing",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h2:"h2",h3:"h3",li:"li",p:"p",pre:"pre",ul:"ul",...(0,i.R)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(n.h2,{id:"description",children:"Description"}),"\n",(0,c.jsxs)(n.p,{children:["The ",(0,c.jsx)(n.code,{children:"npm"})," package ",(0,c.jsx)(n.code,{children:"@open-sauced/check-engines"})," is designed to help contributors install dependencies conforming to the ",(0,c.jsx)(n.code,{children:"engines"})," property in ",(0,c.jsx)(n.code,{children:"package.json"}),"."]}),"\n",(0,c.jsx)(n.h2,{id:"dependencies",children:"Dependencies"}),"\n",(0,c.jsx)(n.p,{children:"This package uses the following modules:"}),"\n",(0,c.jsxs)(n.ul,{children:["\n",(0,c.jsx)(n.li,{children:(0,c.jsx)(n.a,{href:"https://github.com/npm/npm-install-checks",children:"npm-install-checks"})}),"\n"]}),"\n",(0,c.jsx)(n.h2,{id:"installation",children:"Installation"}),"\n",(0,c.jsx)(n.pre,{children:(0,c.jsx)(n.code,{className:"language-shell",children:"npm install --save-dev @open-sauced/check-engines\n"})}),"\n",(0,c.jsxs)(n.p,{children:["Add the verification scripts to your ",(0,c.jsx)(n.code,{children:"scripts"})," section in the ",(0,c.jsx)(n.code,{children:"package.json"})," file:"]}),"\n",(0,c.jsx)(n.pre,{children:(0,c.jsx)(n.code,{className:"language-json",children:'{\n "scripts": {\n "preinstall": "npx @open-sauced/check-engines"\n }\n}\n'})}),"\n",(0,c.jsxs)(n.p,{children:["The reason why we provide ",(0,c.jsx)(n.code,{children:"npx"})," in the ",(0,c.jsx)(n.code,{children:"scripts"})," section is for the people using this as a development enhancement, interactive configurations or trimmed dependency trees, where using ",(0,c.jsx)(n.code,{children:"npx"})," is preferred over installing all the dependencies at once."]}),"\n",(0,c.jsx)(n.h2,{id:"usage",children:"Usage"}),"\n",(0,c.jsx)(n.p,{children:"Use your favorite package manager to install dependencies in your project or, if you set it as a global verification system:"}),"\n",(0,c.jsx)(n.pre,{children:(0,c.jsx)(n.code,{className:"language-json",children:'{\n "scripts": {\n "check-engines": "npx @open-sauced/check-engines"\n "preinstall": "npm run check-engines",\n "prestart": "npm run check-engines"\n }\n}\n'})}),"\n",(0,c.jsx)(n.h2,{id:"advanced-usage",children:"Advanced Usage"}),"\n",(0,c.jsx)(n.p,{children:"If you have an API or any other non-library type of application, you can decouple this package from any install scripts and just use it as a verification:"}),"\n",(0,c.jsx)(n.pre,{children:(0,c.jsx)(n.code,{className:"language-json",children:'{\n "scripts": {\n "check-engines": "npx @open-sauced/check-engines"\n "prestart": "npm run check-engines"\n }\n}\n'})}),"\n",(0,c.jsxs)(n.p,{children:["A more traditional approach not using ",(0,c.jsx)(n.code,{children:"pre"})," or ",(0,c.jsx)(n.code,{children:"post"})," scripts, this example enables the check only for local machine development:"]}),"\n",(0,c.jsx)(n.pre,{children:(0,c.jsx)(n.code,{className:"language-json",children:'{\n "scripts": {\n "check-engines": "npx @open-sauced/check-engines"\n "start": "...",\n "dev": "npm run check-engines && npm start -- --watch"\n }\n}\n'})}),"\n",(0,c.jsx)(n.h2,{id:"faqs",children:"FAQs"}),"\n",(0,c.jsxs)(n.h3,{id:"usage-on-an-older-node-and-npm-versions",children:["Usage on an Older ",(0,c.jsx)(n.code,{children:"node"})," and ",(0,c.jsx)(n.code,{children:"npm"})," Versions"]}),"\n",(0,c.jsxs)(n.p,{children:["Older ",(0,c.jsx)(n.code,{children:"node"})," and ",(0,c.jsx)(n.code,{children:"npm"})," versions won't be able to run this package; depending on the versions, the scripts section could be ignored completely."]}),"\n",(0,c.jsx)(n.p,{children:"If you have that use case, this package is only worth enabling for progressive contributors frequently missing the legacy support of the respective module and forcefully upgrading dependencies - them running newer versions will force the error message and explicitly disable."}),"\n",(0,c.jsxs)(n.h3,{id:"why-not-use-check-engines-or-engine-strict",children:["Why Not Use ",(0,c.jsx)(n.code,{children:"check-engines"})," or ",(0,c.jsx)(n.code,{children:"engine-strict"}),"?"]}),"\n",(0,c.jsxs)(n.p,{children:["As described in the ",(0,c.jsx)(n.code,{children:"npm@6"})," ",(0,c.jsx)(n.a,{href:"https://docs.npmjs.com/cli/v6/configuring-npm/package-json#enginestrict",children:"engine-strict docs"}),":"]}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:["Prior to npm 3.0.0, this feature was used to treat this package as if the user had set ",(0,c.jsx)(n.code,{children:"engine-strict"}),". It is no longer used."]}),"\n"]}),"\n",(0,c.jsxs)(n.p,{children:["In ",(0,c.jsx)(n.code,{children:"npm@6"})," and later, this was re-introduced as a ",(0,c.jsx)(n.a,{href:"https://docs.npmjs.com/cli/v7/using-npm/config#engine-strict",children:"config flag"}),"."]}),"\n",(0,c.jsx)(n.p,{children:"This package is designed with multiple legacy use cases in mind."}),"\n",(0,c.jsx)(n.h3,{id:"library-usage",children:"Library Usage"}),"\n",(0,c.jsxs)(n.p,{children:["If you use this module in a library package, be advised that any ",(0,c.jsx)(n.code,{children:"*install"})," script will run in the parent module when installed."]}),"\n",(0,c.jsxs)(n.p,{children:["For example, given a module ",(0,c.jsx)(n.code,{children:"@demo-org/demo-package"})," with a ",(0,c.jsx)(n.code,{children:'preinstall: "npx @open-sauced/check-engines"'})," script, running ",(0,c.jsx)(n.code,{children:"npm install @demo-org/demo-package"})," will require your locally installed ",(0,c.jsx)(n.code,{children:"node"})," and ",(0,c.jsx)(n.code,{children:"npm"})," versions to match the ",(0,c.jsx)(n.code,{children:"engines"})," section of your ",(0,c.jsx)(n.code,{children:"package.json"}),". If that is not set, nothing should happen, and this package is a stray dependency in either ",(0,c.jsx)(n.code,{children:"@demo-org/demo-package"})," or the module you are running this command in."]}),"\n",(0,c.jsx)(n.h2,{id:"contributing",children:"Contributing"}),"\n",(0,c.jsx)(n.p,{children:"We're always happy to onboard people into open source!"}),"\n",(0,c.jsxs)(n.p,{children:["Check out the repository at ",(0,c.jsx)(n.a,{href:"https://github.com/open-sauced/check-engines",children:"@open-sauced/check-engines"}),". \u2764\ufe0f"]})]})}function h(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,c.jsx)(n,{...e,children:(0,c.jsx)(l,{...e})}):l(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>a,x:()=>d});var c=s(6540);const i={},o=c.createContext(i);function a(e){const n=c.useContext(o);return c.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:a(e.components),c.createElement(o.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/561e6817.0f28d5df.js b/assets/js/561e6817.0f28d5df.js
deleted file mode 100644
index fdc8845f..00000000
--- a/assets/js/561e6817.0f28d5df.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunk_open_sauced_docs_opensauced_pizza=self.webpackChunk_open_sauced_docs_opensauced_pizza||[]).push([[4150],{2346:(e,o,n)=>{n.r(o),n.d(o,{assets:()=>u,contentTitle:()=>c,default:()=>l,frontMatter:()=>s,metadata:()=>r,toc:()=>a});var t=n(4848),i=n(8453);const s={id:"welcome-to-the-community",title:"Welcome to the OpenSauced Community",sidebar_label:"Welcome to the Community",keywords:["welcome to the community","The community welcomes you","Get involved in the community","Join our community","Greetings from the community"]},c=void 0,r={id:"community/welcome-to-the-community",title:"Welcome to the OpenSauced Community",description:"Welcome to the OpenSauced community! At OpenSauced, we strive to bring collaboration and inspiration to every open source contributor and help build a global community of open source developers, empowering you to grow, innovate, and achieve greatness in the open.",source:"@site/docs/community/welcome-to-the-community.md",sourceDirName:"community",slug:"/community/welcome-to-the-community",permalink:"/community/welcome-to-the-community",draft:!1,unlisted:!1,editUrl:"https://github.com/open-sauced/docs.opensauced.pizza/edit/main/docs/community/welcome-to-the-community.md",tags:[],version:"current",lastUpdatedBy:"BekahHW",lastUpdatedAt:171701191e4,frontMatter:{id:"welcome-to-the-community",title:"Welcome to the OpenSauced Community",sidebar_label:"Welcome to the Community",keywords:["welcome to the community","The community welcomes you","Get involved in the community","Join our community","Greetings from the community"]},sidebar:"docs",previous:{title:"Contributors Guide to OpenSauced",permalink:"/contributors/contributors-guide-to-open-sauced"},next:{title:"#100DaysOfOSS",permalink:"/community/100-days-of-oss"}},u={},a=[{value:"Community Guidelines",id:"community-guidelines",level:2},{value:"Keeping Up with OpenSauced",id:"keeping-up-with-opensauced",level:2},{value:"How to Get Involved",id:"how-to-get-involved",level:2},{value:"Resources on Getting Started with Open Source",id:"resources-on-getting-started-with-open-source",level:2}];function d(e){const o={a:"a",h2:"h2",li:"li",p:"p",ul:"ul",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(o.p,{children:"Welcome to the OpenSauced community! At OpenSauced, we strive to bring collaboration and inspiration to every open source contributor and help build a global community of open source developers, empowering you to grow, innovate, and achieve greatness in the open."}),"\n",(0,t.jsx)(o.h2,{id:"community-guidelines",children:"Community Guidelines"}),"\n",(0,t.jsx)(o.p,{children:"We pledge to create a welcoming and inclusive community for everyone at OpenSauced. We have a few guidelines to help us achieve this goal:"}),"\n",(0,t.jsxs)(o.ul,{children:["\n",(0,t.jsx)(o.li,{children:"Be respectful and kind to others in the community."}),"\n",(0,t.jsx)(o.li,{children:"Be patient with others and help them learn."}),"\n",(0,t.jsx)(o.li,{children:"Be open to feedback and constructive criticism."}),"\n",(0,t.jsxs)(o.li,{children:["Adhere to the ",(0,t.jsx)(o.a,{href:"/contributing/code-of-conduct",children:"Code of Conduct"}),"."]}),"\n"]}),"\n",(0,t.jsx)(o.h2,{id:"keeping-up-with-opensauced",children:"Keeping Up with OpenSauced"}),"\n",(0,t.jsx)(o.p,{children:"The OpenSauced community is a group of open source enthusiasts who are passionate about making open source more accessible to everyone. Here are some ways you can keep up with what we're doing:"}),"\n",(0,t.jsxs)(o.ul,{children:["\n",(0,t.jsxs)(o.li,{children:["Follow us on X ",(0,t.jsx)(o.a,{href:"https://twitter.com/saucedopen",children:"@SaucedOpen"})," for announcements and our frequent X Spaces."]}),"\n",(0,t.jsxs)(o.li,{children:["Join our ",(0,t.jsx)(o.a,{href:"https://discord.gg/opensauced",children:"Discord"})," and hang out with us during our weekly office hours."]}),"\n",(0,t.jsxs)(o.li,{children:["Subscribe to our ",(0,t.jsx)(o.a,{href:"https://www.youtube.com/@OpenSauced",children:"YouTube channel"})," for the latest updates and video content for OpenSauced."]}),"\n",(0,t.jsxs)(o.li,{children:["\ud83d\udcf0 Subscribe to our ",(0,t.jsx)(o.a,{href:"https://news.opensauced.pizza/#/portal/signup",children:"newsletter"})," for all things OpenSauced and open source."]}),"\n",(0,t.jsxs)(o.li,{children:["\ud83d\uddd3\ufe0f Check out the ",(0,t.jsx)(o.a,{href:"https://calendar.google.com/calendar/u/0?cid=Y19kYWRhODM2MjlhZDg4ZWM2M2IxZGFmMTE5MDIyMDg0MjU2ZmQ4NmNjNWNhYmMxMjk5MDhjMGUxOTY3NjY4ZTg0QGdyb3VwLmNhbGVuZGFyLmdvb2dsZS5jb20",children:"calendar"})," for our next weekly community chat."]}),"\n"]}),"\n",(0,t.jsx)(o.h2,{id:"how-to-get-involved",children:"How to Get Involved"}),"\n",(0,t.jsx)(o.p,{children:"You can get involved in the OpenSauced community in a few ways:"}),"\n",(0,t.jsxs)(o.ul,{children:["\n",(0,t.jsxs)(o.li,{children:["Share your contributions! We love to see what you're working on. Highlight your contributions on ",(0,t.jsx)(o.a,{href:"https://app.opensauced.pizza/feed",children:"OpenSauced"}),"."]}),"\n",(0,t.jsxs)(o.li,{children:["Open an issue or ask to be assigned to an existing issue on any of our ",(0,t.jsx)(o.a,{href:"https://github.com/open-sauced",children:"OpenSauced repositories"}),"."]}),"\n",(0,t.jsxs)(o.li,{children:["Share what you're working on, ask questions, or mentor new contributors in our ",(0,t.jsx)(o.a,{href:"https://discord.gg/opensauced",children:"Discord"}),"."]}),"\n",(0,t.jsxs)(o.li,{children:["Provide feedback on our ",(0,t.jsx)(o.a,{href:"https://github.com/orgs/open-sauced/discussions",children:"GitHub Discussions"}),"."]}),"\n"]}),"\n",(0,t.jsx)(o.h2,{id:"resources-on-getting-started-with-open-source",children:"Resources on Getting Started with Open Source"}),"\n",(0,t.jsx)(o.p,{children:"Getting started with open source can be challenging, so we've put together some resources to help you get started."}),"\n",(0,t.jsxs)(o.ul,{children:["\n",(0,t.jsxs)(o.li,{children:["\ud83d\udcdd Check out our ",(0,t.jsx)(o.a,{href:"https://dev.to/opensauced",children:"blog on Dev.to"}),", where we provide resources for open source contributors."]}),"\n",(0,t.jsxs)(o.li,{children:["\ud83d\udcd6 Take our ",(0,t.jsx)(o.a,{href:"https://intro.opensauced.pizza/#/",children:"Intro to Open Source Course"})," to help you start with open source."]}),"\n",(0,t.jsxs)(o.li,{children:["\ud83d\udcc5 Join our ",(0,t.jsx)(o.a,{href:"/community/100-days-of-oss",children:"#100DaysOfOSS Challenge"})," to help you grow your skills and gain real-world experience in open source."]}),"\n"]})]})}function l(e={}){const{wrapper:o}={...(0,i.R)(),...e.components};return o?(0,t.jsx)(o,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},8453:(e,o,n)=>{n.d(o,{R:()=>c,x:()=>r});var t=n(6540);const i={},s=t.createContext(i);function c(e){const o=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(o):{...o,...e}}),[o,e])}function r(e){let o;return o=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),t.createElement(s.Provider,{value:o},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/561e6817.3ad76765.js b/assets/js/561e6817.3ad76765.js
new file mode 100644
index 00000000..04a1c358
--- /dev/null
+++ b/assets/js/561e6817.3ad76765.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunk_open_sauced_docs_opensauced_pizza=self.webpackChunk_open_sauced_docs_opensauced_pizza||[]).push([[4150],{2346:(e,o,n)=>{n.r(o),n.d(o,{assets:()=>u,contentTitle:()=>c,default:()=>l,frontMatter:()=>s,metadata:()=>r,toc:()=>a});var t=n(4848),i=n(8453);const s={id:"welcome-to-the-community",title:"Welcome to the OpenSauced Community",sidebar_label:"Welcome to the Community",keywords:["welcome to the community","The community welcomes you","Get involved in the community","Join our community","Greetings from the community"]},c=void 0,r={id:"community/welcome-to-the-community",title:"Welcome to the OpenSauced Community",description:"Welcome to the OpenSauced community! At OpenSauced, we strive to bring collaboration and inspiration to every open source contributor and help build a global community of open source developers, empowering you to grow, innovate, and achieve greatness in the open.",source:"@site/docs/community/welcome-to-the-community.md",sourceDirName:"community",slug:"/community/welcome-to-the-community",permalink:"/community/welcome-to-the-community",draft:!1,unlisted:!1,editUrl:"https://github.com/open-sauced/docs.opensauced.pizza/edit/main/docs/community/welcome-to-the-community.md",tags:[],version:"current",lastUpdatedBy:"BekahHW",lastUpdatedAt:1717170876e3,frontMatter:{id:"welcome-to-the-community",title:"Welcome to the OpenSauced Community",sidebar_label:"Welcome to the Community",keywords:["welcome to the community","The community welcomes you","Get involved in the community","Join our community","Greetings from the community"]},sidebar:"docs",previous:{title:"Contributors Guide to OpenSauced",permalink:"/contributors/contributors-guide-to-open-sauced"},next:{title:"#100DaysOfOSS",permalink:"/community/100-days-of-oss"}},u={},a=[{value:"Community Guidelines",id:"community-guidelines",level:2},{value:"Keeping Up with OpenSauced",id:"keeping-up-with-opensauced",level:2},{value:"How to Get Involved",id:"how-to-get-involved",level:2},{value:"Resources on Getting Started with Open Source",id:"resources-on-getting-started-with-open-source",level:2}];function d(e){const o={a:"a",h2:"h2",li:"li",p:"p",ul:"ul",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(o.p,{children:"Welcome to the OpenSauced community! At OpenSauced, we strive to bring collaboration and inspiration to every open source contributor and help build a global community of open source developers, empowering you to grow, innovate, and achieve greatness in the open."}),"\n",(0,t.jsx)(o.h2,{id:"community-guidelines",children:"Community Guidelines"}),"\n",(0,t.jsx)(o.p,{children:"We pledge to create a welcoming and inclusive community for everyone at OpenSauced. We have a few guidelines to help us achieve this goal:"}),"\n",(0,t.jsxs)(o.ul,{children:["\n",(0,t.jsx)(o.li,{children:"Be respectful and kind to others in the community."}),"\n",(0,t.jsx)(o.li,{children:"Be patient with others and help them learn."}),"\n",(0,t.jsx)(o.li,{children:"Be open to feedback and constructive criticism."}),"\n",(0,t.jsxs)(o.li,{children:["Adhere to the ",(0,t.jsx)(o.a,{href:"/contributing/code-of-conduct",children:"Code of Conduct"}),"."]}),"\n"]}),"\n",(0,t.jsx)(o.h2,{id:"keeping-up-with-opensauced",children:"Keeping Up with OpenSauced"}),"\n",(0,t.jsx)(o.p,{children:"The OpenSauced community is a group of open source enthusiasts who are passionate about making open source more accessible to everyone. Here are some ways you can keep up with what we're doing:"}),"\n",(0,t.jsxs)(o.ul,{children:["\n",(0,t.jsxs)(o.li,{children:["Follow us on X ",(0,t.jsx)(o.a,{href:"https://twitter.com/saucedopen",children:"@SaucedOpen"})," for announcements and our frequent X Spaces."]}),"\n",(0,t.jsxs)(o.li,{children:["Join our ",(0,t.jsx)(o.a,{href:"https://discord.gg/opensauced",children:"Discord"})," and hang out with us during our weekly office hours."]}),"\n",(0,t.jsxs)(o.li,{children:["Subscribe to our ",(0,t.jsx)(o.a,{href:"https://www.youtube.com/@OpenSauced",children:"YouTube channel"})," for the latest updates and video content for OpenSauced."]}),"\n",(0,t.jsxs)(o.li,{children:["\ud83d\udcf0 Subscribe to our ",(0,t.jsx)(o.a,{href:"https://news.opensauced.pizza/#/portal/signup",children:"newsletter"})," for all things OpenSauced and open source."]}),"\n",(0,t.jsxs)(o.li,{children:["\ud83d\uddd3\ufe0f Check out the ",(0,t.jsx)(o.a,{href:"https://calendar.google.com/calendar/u/0?cid=Y19kYWRhODM2MjlhZDg4ZWM2M2IxZGFmMTE5MDIyMDg0MjU2ZmQ4NmNjNWNhYmMxMjk5MDhjMGUxOTY3NjY4ZTg0QGdyb3VwLmNhbGVuZGFyLmdvb2dsZS5jb20",children:"calendar"})," for our next weekly community chat."]}),"\n"]}),"\n",(0,t.jsx)(o.h2,{id:"how-to-get-involved",children:"How to Get Involved"}),"\n",(0,t.jsx)(o.p,{children:"You can get involved in the OpenSauced community in a few ways:"}),"\n",(0,t.jsxs)(o.ul,{children:["\n",(0,t.jsxs)(o.li,{children:["Share your contributions! We love to see what you're working on. Highlight your contributions on ",(0,t.jsx)(o.a,{href:"https://app.opensauced.pizza/feed",children:"OpenSauced"}),"."]}),"\n",(0,t.jsxs)(o.li,{children:["Open an issue or ask to be assigned to an existing issue on any of our ",(0,t.jsx)(o.a,{href:"https://github.com/open-sauced",children:"OpenSauced repositories"}),"."]}),"\n",(0,t.jsxs)(o.li,{children:["Share what you're working on, ask questions, or mentor new contributors in our ",(0,t.jsx)(o.a,{href:"https://discord.gg/opensauced",children:"Discord"}),"."]}),"\n",(0,t.jsxs)(o.li,{children:["Provide feedback on our ",(0,t.jsx)(o.a,{href:"https://github.com/orgs/open-sauced/discussions",children:"GitHub Discussions"}),"."]}),"\n"]}),"\n",(0,t.jsx)(o.h2,{id:"resources-on-getting-started-with-open-source",children:"Resources on Getting Started with Open Source"}),"\n",(0,t.jsx)(o.p,{children:"Getting started with open source can be challenging, so we've put together some resources to help you get started."}),"\n",(0,t.jsxs)(o.ul,{children:["\n",(0,t.jsxs)(o.li,{children:["\ud83d\udcdd Check out our ",(0,t.jsx)(o.a,{href:"https://dev.to/opensauced",children:"blog on Dev.to"}),", where we provide resources for open source contributors."]}),"\n",(0,t.jsxs)(o.li,{children:["\ud83d\udcd6 Take our ",(0,t.jsx)(o.a,{href:"https://intro.opensauced.pizza/#/",children:"Intro to Open Source Course"})," to help you start with open source."]}),"\n",(0,t.jsxs)(o.li,{children:["\ud83d\udcc5 Join our ",(0,t.jsx)(o.a,{href:"/community/100-days-of-oss",children:"#100DaysOfOSS Challenge"})," to help you grow your skills and gain real-world experience in open source."]}),"\n"]})]})}function l(e={}){const{wrapper:o}={...(0,i.R)(),...e.components};return o?(0,t.jsx)(o,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},8453:(e,o,n)=>{n.d(o,{R:()=>c,x:()=>r});var t=n(6540);const i={},s=t.createContext(i);function c(e){const o=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(o):{...o,...e}}),[o,e])}function r(e){let o;return o=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),t.createElement(s.Provider,{value:o},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/580fd761.4f75e3ea.js b/assets/js/580fd761.4f75e3ea.js
new file mode 100644
index 00000000..3af41893
--- /dev/null
+++ b/assets/js/580fd761.4f75e3ea.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunk_open_sauced_docs_opensauced_pizza=self.webpackChunk_open_sauced_docs_opensauced_pizza||[]).push([[3602],{9231:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>u,frontMatter:()=>r,metadata:()=>s,toc:()=>d});var t=i(4848),o=i(8453);const r={id:"code-of-conduct",title:"Code of Conduct",sidebar_label:"Code of Conduct",keywords:["code of conduct","Community guidelines","Guidelines for behavior","Interaction guidelines","rules and guidelines","Behavioral expectations"]},a=void 0,s={id:"contributing/code-of-conduct",title:"Code of Conduct",description:"Our Pledge",source:"@site/docs/contributing/code-of-conduct.md",sourceDirName:"contributing",slug:"/contributing/code-of-conduct",permalink:"/contributing/code-of-conduct",draft:!1,unlisted:!1,editUrl:"https://github.com/open-sauced/docs.opensauced.pizza/edit/main/docs/contributing/code-of-conduct.md",tags:[],version:"current",lastUpdatedBy:"BekahHW",lastUpdatedAt:1717170876e3,frontMatter:{id:"code-of-conduct",title:"Code of Conduct",sidebar_label:"Code of Conduct",keywords:["code of conduct","Community guidelines","Guidelines for behavior","Interaction guidelines","rules and guidelines","Behavioral expectations"]},sidebar:"docs",previous:{title:"Introduction to Contributing",permalink:"/contributing/introduction-to-contributing"},next:{title:"Triage Guide",permalink:"/contributing/triage-guide"}},c={},d=[{value:"Our Pledge",id:"our-pledge",level:2},{value:"Our Standards",id:"our-standards",level:2},{value:"Our Responsibilities",id:"our-responsibilities",level:2},{value:"Scope",id:"scope",level:2},{value:"Enforcement",id:"enforcement",level:2},{value:"Attribution",id:"attribution",level:2}];function l(e){const n={a:"a",h2:"h2",li:"li",p:"p",ul:"ul",...(0,o.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h2,{id:"our-pledge",children:"Our Pledge"}),"\n",(0,t.jsx)(n.p,{children:"In the interest of fostering an open and welcoming environment, we as\ncontributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation."}),"\n",(0,t.jsx)(n.h2,{id:"our-standards",children:"Our Standards"}),"\n",(0,t.jsx)(n.p,{children:"Examples of behavior that contributes to creating a positive environment\ninclude:"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:"Using welcoming and inclusive language."}),"\n",(0,t.jsx)(n.li,{children:"Being respectful of differing viewpoints and experiences."}),"\n",(0,t.jsx)(n.li,{children:"Gracefully accepting constructive criticism."}),"\n",(0,t.jsx)(n.li,{children:"Focusing on what is best for the community."}),"\n",(0,t.jsx)(n.li,{children:"Showing empathy towards other community members."}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Examples of unacceptable behavior by participants include:"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:"The use of sexualized language or imagery and unwelcome sexual attention or advances."}),"\n",(0,t.jsx)(n.li,{children:"Trolling, insulting/derogatory comments, and personal or political attacks."}),"\n",(0,t.jsx)(n.li,{children:"Public or private harassment."}),"\n",(0,t.jsx)(n.li,{children:"Publishing others' confidential information, such as a physical or electronic address, without explicit permission."}),"\n",(0,t.jsx)(n.li,{children:"Other conduct that could reasonably be considered inappropriate in a professional setting."}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"our-responsibilities",children:"Our Responsibilities"}),"\n",(0,t.jsx)(n.p,{children:"Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior."}),"\n",(0,t.jsx)(n.p,{children:"Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned with this Code of Conduct or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful."}),"\n",(0,t.jsx)(n.h2,{id:"scope",children:"Scope"}),"\n",(0,t.jsx)(n.p,{children:"This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include:"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:"Using an official project e-mail address."}),"\n",(0,t.jsx)(n.li,{children:"Posting via an official social media account."}),"\n",(0,t.jsx)(n.li,{children:"Acting as an appointed representative at an online or offline event."}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Representation of a project may be further defined and clarified by project maintainers."}),"\n",(0,t.jsx)(n.h2,{id:"enforcement",children:"Enforcement"}),"\n",(0,t.jsxs)(n.p,{children:["Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at ",(0,t.jsx)(n.a,{href:"mailto:hello@briandouglas.me",children:"hello@briandouglas.me"}),". All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident.\nFurther details of specific enforcement policies may be posted separately."]}),"\n",(0,t.jsx)(n.p,{children:"Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership."}),"\n",(0,t.jsx)(n.h2,{id:"attribution",children:"Attribution"}),"\n",(0,t.jsxs)(n.p,{children:["This Code of Conduct is adapted from the ",(0,t.jsx)(n.a,{href:"https://contributor-covenant.org",children:"Contributor Covenant"})," version 1.4,\navailable at ",(0,t.jsx)(n.a,{href:"https://contributor-covenant.org/version/1/4/",children:"https://contributor-covenant.org/version/1/4"}),"."]})]})}function u(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},8453:(e,n,i)=>{i.d(n,{R:()=>a,x:()=>s});var t=i(6540);const o={},r=t.createContext(o);function a(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:a(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/580fd761.ddd2340a.js b/assets/js/580fd761.ddd2340a.js
deleted file mode 100644
index 47caa0a8..00000000
--- a/assets/js/580fd761.ddd2340a.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunk_open_sauced_docs_opensauced_pizza=self.webpackChunk_open_sauced_docs_opensauced_pizza||[]).push([[3602],{9231:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>u,frontMatter:()=>r,metadata:()=>s,toc:()=>d});var t=i(4848),o=i(8453);const r={id:"code-of-conduct",title:"Code of Conduct",sidebar_label:"Code of Conduct",keywords:["code of conduct","Community guidelines","Guidelines for behavior","Interaction guidelines","rules and guidelines","Behavioral expectations"]},a=void 0,s={id:"contributing/code-of-conduct",title:"Code of Conduct",description:"Our Pledge",source:"@site/docs/contributing/code-of-conduct.md",sourceDirName:"contributing",slug:"/contributing/code-of-conduct",permalink:"/contributing/code-of-conduct",draft:!1,unlisted:!1,editUrl:"https://github.com/open-sauced/docs.opensauced.pizza/edit/main/docs/contributing/code-of-conduct.md",tags:[],version:"current",lastUpdatedBy:"BekahHW",lastUpdatedAt:171701191e4,frontMatter:{id:"code-of-conduct",title:"Code of Conduct",sidebar_label:"Code of Conduct",keywords:["code of conduct","Community guidelines","Guidelines for behavior","Interaction guidelines","rules and guidelines","Behavioral expectations"]},sidebar:"docs",previous:{title:"Introduction to Contributing",permalink:"/contributing/introduction-to-contributing"},next:{title:"Triage Guide",permalink:"/contributing/triage-guide"}},c={},d=[{value:"Our Pledge",id:"our-pledge",level:2},{value:"Our Standards",id:"our-standards",level:2},{value:"Our Responsibilities",id:"our-responsibilities",level:2},{value:"Scope",id:"scope",level:2},{value:"Enforcement",id:"enforcement",level:2},{value:"Attribution",id:"attribution",level:2}];function l(e){const n={a:"a",h2:"h2",li:"li",p:"p",ul:"ul",...(0,o.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h2,{id:"our-pledge",children:"Our Pledge"}),"\n",(0,t.jsx)(n.p,{children:"In the interest of fostering an open and welcoming environment, we as\ncontributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation."}),"\n",(0,t.jsx)(n.h2,{id:"our-standards",children:"Our Standards"}),"\n",(0,t.jsx)(n.p,{children:"Examples of behavior that contributes to creating a positive environment\ninclude:"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:"Using welcoming and inclusive language."}),"\n",(0,t.jsx)(n.li,{children:"Being respectful of differing viewpoints and experiences."}),"\n",(0,t.jsx)(n.li,{children:"Gracefully accepting constructive criticism."}),"\n",(0,t.jsx)(n.li,{children:"Focusing on what is best for the community."}),"\n",(0,t.jsx)(n.li,{children:"Showing empathy towards other community members."}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Examples of unacceptable behavior by participants include:"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:"The use of sexualized language or imagery and unwelcome sexual attention or advances."}),"\n",(0,t.jsx)(n.li,{children:"Trolling, insulting/derogatory comments, and personal or political attacks."}),"\n",(0,t.jsx)(n.li,{children:"Public or private harassment."}),"\n",(0,t.jsx)(n.li,{children:"Publishing others' confidential information, such as a physical or electronic address, without explicit permission."}),"\n",(0,t.jsx)(n.li,{children:"Other conduct that could reasonably be considered inappropriate in a professional setting."}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"our-responsibilities",children:"Our Responsibilities"}),"\n",(0,t.jsx)(n.p,{children:"Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior."}),"\n",(0,t.jsx)(n.p,{children:"Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned with this Code of Conduct or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful."}),"\n",(0,t.jsx)(n.h2,{id:"scope",children:"Scope"}),"\n",(0,t.jsx)(n.p,{children:"This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include:"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:"Using an official project e-mail address."}),"\n",(0,t.jsx)(n.li,{children:"Posting via an official social media account."}),"\n",(0,t.jsx)(n.li,{children:"Acting as an appointed representative at an online or offline event."}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Representation of a project may be further defined and clarified by project maintainers."}),"\n",(0,t.jsx)(n.h2,{id:"enforcement",children:"Enforcement"}),"\n",(0,t.jsxs)(n.p,{children:["Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at ",(0,t.jsx)(n.a,{href:"mailto:hello@briandouglas.me",children:"hello@briandouglas.me"}),". All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident.\nFurther details of specific enforcement policies may be posted separately."]}),"\n",(0,t.jsx)(n.p,{children:"Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership."}),"\n",(0,t.jsx)(n.h2,{id:"attribution",children:"Attribution"}),"\n",(0,t.jsxs)(n.p,{children:["This Code of Conduct is adapted from the ",(0,t.jsx)(n.a,{href:"https://contributor-covenant.org",children:"Contributor Covenant"})," version 1.4,\navailable at ",(0,t.jsx)(n.a,{href:"https://contributor-covenant.org/version/1/4/",children:"https://contributor-covenant.org/version/1/4"}),"."]})]})}function u(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},8453:(e,n,i)=>{i.d(n,{R:()=>a,x:()=>s});var t=i(6540);const o={},r=t.createContext(o);function a(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:a(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/5a367a69.19a9b1fc.js b/assets/js/5a367a69.19a9b1fc.js
new file mode 100644
index 00000000..3a931c0d
--- /dev/null
+++ b/assets/js/5a367a69.19a9b1fc.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunk_open_sauced_docs_opensauced_pizza=self.webpackChunk_open_sauced_docs_opensauced_pizza||[]).push([[8373],{9468:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>l,contentTitle:()=>c,default:()=>h,frontMatter:()=>s,metadata:()=>r,toc:()=>a});var i=t(4848),o=t(8453);const s={id:"resolve-merge-conflicts",title:"Resolve Merge Conflicts",sidebar_label:"Resolve Merge Conflicts",keywords:["resolve merge conflicts","solve merge conflicts","Git merge conflict","Merge conflict resolution","Merge conflict prevention","Merge conflict handling","Merge conflict management","Merge conflict avoidance","Merge conflict workflow","Merge conflict strategies","Merge conflict best practices","Merge conflict tools"]},c=void 0,r={id:"contributing/technical/resolve-merge-conflicts",title:"Resolve Merge Conflicts",description:"When you are working on any of the OpenSauced repositories, you might run into a merge conflict. A merge conflict occurs when multiple conflicting changes are made to the same line in a file. Merge conflicts happen the most when you open a pull request, as the release process generally updates npm-shrinkwrap.json.",source:"@site/docs/contributing/technical/resolve-merge-conflicts.md",sourceDirName:"contributing/technical",slug:"/contributing/technical/resolve-merge-conflicts",permalink:"/contributing/technical/resolve-merge-conflicts",draft:!1,unlisted:!1,editUrl:"https://github.com/open-sauced/docs.opensauced.pizza/edit/main/docs/contributing/technical/resolve-merge-conflicts.md",tags:[],version:"current",lastUpdatedBy:"BekahHW",lastUpdatedAt:1717170876e3,frontMatter:{id:"resolve-merge-conflicts",title:"Resolve Merge Conflicts",sidebar_label:"Resolve Merge Conflicts",keywords:["resolve merge conflicts","solve merge conflicts","Git merge conflict","Merge conflict resolution","Merge conflict prevention","Merge conflict handling","Merge conflict management","Merge conflict avoidance","Merge conflict workflow","Merge conflict strategies","Merge conflict best practices","Merge conflict tools"]},sidebar:"docs",previous:{title:"Setting Up a Repository with Git and GitHub",permalink:"/contributing/technical/setup-repo-with-git"},next:{title:"@open-sauced/check-engines",permalink:"/opensauced-packages/check-engines"}},l={},a=[{value:"How to Keep Your Branch Updated",id:"how-to-keep-your-branch-updated",level:2},{value:"Using GitHub",id:"using-github",level:3},{value:"Using Git",id:"using-git",level:3},{value:"How to Check for Merge Conflicts Locally",id:"how-to-check-for-merge-conflicts-locally",level:2},{value:"How to Resolve Merge Conflicts",id:"how-to-resolve-merge-conflicts",level:2},{value:"Reviewing Your Pull Request",id:"reviewing-your-pull-request",level:2},{value:"Dependency Updates",id:"dependency-updates",level:2}];function d(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",img:"img",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsxs)(n.p,{children:["When you are working on any of the OpenSauced repositories, you might run into a merge conflict. A merge conflict occurs when multiple conflicting changes are made to the same line in a file. Merge conflicts happen the most when you open a pull request, as the release process generally updates ",(0,i.jsx)(n.code,{children:"npm-shrinkwrap.json"}),"."]}),"\n",(0,i.jsx)(n.p,{children:"In this guide, we will talk about how to resolve merge conflicts and how to keep your branch up to date."}),"\n",(0,i.jsx)(n.h2,{id:"how-to-keep-your-branch-updated",children:"How to Keep Your Branch Updated"}),"\n",(0,i.jsx)(n.p,{children:"It is common for your branch to fall behind the main repository's branch. So it is important to keep it up to date as you are contributing."}),"\n",(0,i.jsx)(n.h3,{id:"using-github",children:"Using GitHub"}),"\n",(0,i.jsxs)(n.p,{children:["To update your branch on GitHub, you can go to your forked copy of the project and click on ",(0,i.jsx)(n.code,{children:"Sync fork"})," and then the ",(0,i.jsx)(n.code,{children:"Update branch"})," button."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.img,{alt:"syncing your branch on GitHub",src:t(4935).A+"",width:"2056",height:"1090"})}),"\n",(0,i.jsx)(n.h3,{id:"using-git",children:"Using Git"}),"\n",(0,i.jsx)(n.p,{children:"To update your branch using Git and the terminal, you can use the following commands:"}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:"Change directories to the correct project."}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-bash",children:"cd project-name\n"})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsxs)(n.li,{children:["Add the ",(0,i.jsx)(n.code,{children:"upstream"})," remote."]}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-bash",children:"git remote add upstream https://github.com/upstream-username/upstream-repository.git\n"})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsxs)(n.li,{children:["Pull the latest changes from the ",(0,i.jsx)(n.code,{children:"upstream"}),"."]}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-bash",children:"git pull upstream main-branch-name\n"})}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Note"}),": Some of the OpenSauced repositories will use ",(0,i.jsx)(n.code,{children:"main"})," for the main branch while others like the ",(0,i.jsx)(n.a,{href:"https://github.com/open-sauced/app",children:"app repository"}),", will use ",(0,i.jsx)(n.code,{children:"beta"})," for the main branch name."]}),"\n",(0,i.jsx)(n.h2,{id:"how-to-check-for-merge-conflicts-locally",children:"How to Check for Merge Conflicts Locally"}),"\n",(0,i.jsx)(n.p,{children:"If you are actively working on a change to an OpenSauced repository, you can check for potential merge conflicts by running a few commands in the terminal."}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:"Make sure you are on the correct branch where the changes are being made."}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-bash",children:"cd app\ngit checkout good first issue",id:"labeling-good-first-issue",level:3},{value:"Approaches and Best Practices for Getting Into Triage Contributions",id:"approaches-and-best-practices-for-getting-into-triage-contributions",level:2},{value:"Removal of Triage Role",id:"removal-of-triage-role",level:2},{value:"Helpful Hints",id:"helpful-hints",level:2}];function c(e){const i={a:"a",code:"code",h2:"h2",h3:"h3",li:"li",p:"p",strong:"strong",ul:"ul",...(0,t.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(i.h2,{id:"triage-process",children:"Triage Process"}),"\n",(0,n.jsxs)(i.p,{children:["When a new issue or pull request (PR) is opened, the issue will be labeled with ",(0,n.jsx)(i.code,{children:"needs triage"}),". At OpenSauced, our team functions as the triage team. Once a teammate is available, they can help ensure all the required information is provided."]}),"\n",(0,n.jsx)(i.h3,{id:"adding-issue-and-pr-labels",children:"Adding Issue and PR Labels"}),"\n",(0,n.jsx)(i.p,{children:"Depending on the issue or PR, there are several labels the triage team can add for further classification, as follows:"}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.code,{children:"needs triage"}),": This can be kept if the triager is unsure which next steps to take."]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.code,{children:"awaiting more info"}),": If more information has been requested from the author, apply this label."]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.code,{children:"question"}),": User questions that do not appear to be bugs or enhancements."]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.code,{children:"discuss"}),": Topics for discussion. It might end in an ",(0,n.jsx)(i.code,{children:"enhancement"})," or ",(0,n.jsx)(i.code,{children:"question"})," label."]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.code,{children:"bug"}),": Issues that present reasonable conviction there is a reproducible bug."]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.code,{children:"enhancement"}),": Issues that are found to be a reasonable candidate feature additions."]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.code,{children:"style"}),": Minor CSS or visual changes."]}),"\n"]}),"\n",(0,n.jsx)(i.p,{children:"In all cases, maintainers may close issues if they don't receive a timely response when further information is sought or when additional questions are asked."}),"\n",(0,n.jsxs)(i.h3,{id:"labeling-good-first-issue",children:["Labeling ",(0,n.jsx)(i.code,{children:"good first issue"})]}),"\n",(0,n.jsxs)(i.p,{children:["Issues labeled as ",(0,n.jsx)(i.code,{children:"good first issue"})," represent a curated list of easy contributions for new contributors. These issues are meant to help folks make their first contribution to open source and should not require excessive research or triaging on the contributor's part."]}),"\n",(0,n.jsxs)(i.p,{children:["All ",(0,n.jsx)(i.code,{children:"good first issue"})," should include one or more of the following:"]}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsx)(i.li,{children:"A solution."}),"\n",(0,n.jsx)(i.li,{children:"A suggestion for a solution."}),"\n",(0,n.jsx)(i.li,{children:"Links to components or in which issue occurs."}),"\n"]}),"\n",(0,n.jsx)(i.p,{children:"Please be noted:"}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:["Issues that ",(0,n.jsx)(i.code,{children:"needs triage"})," cannot be labeled as ",(0,n.jsx)(i.code,{children:"good first issues"}),"."]}),"\n",(0,n.jsxs)(i.li,{children:["It is better to have no ",(0,n.jsx)(i.code,{children:"good first issue"})," labeled issues than to have a ",(0,n.jsx)(i.code,{children:"good first issue"})," confusing enough to deter a contributor from contributing."]}),"\n"]}),"\n",(0,n.jsx)(i.h2,{id:"approaches-and-best-practices-for-getting-into-triage-contributions",children:"Approaches and Best Practices for Getting Into Triage Contributions"}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:["\n",(0,n.jsx)(i.p,{children:"Review the project's Contribution Guidelines if they are present. In a nutshell, commit to the community's standards and values."}),"\n"]}),"\n",(0,n.jsxs)(i.li,{children:["\n",(0,n.jsxs)(i.p,{children:["Review the documentation; for most projects, it is just the ",(0,n.jsx)(i.code,{children:"README.md"}),". Ensure you understand the key APIs, semantics, configurations, and use cases."]}),"\n"]}),"\n",(0,n.jsxs)(i.li,{children:["\n",(0,n.jsx)(i.p,{children:"Writing your own test apps to reaffirm your understanding of the key functions might be helpful. This may identify some gaps in documentation; record those as they might be good PRs to open."}),"\n"]}),"\n",(0,n.jsxs)(i.li,{children:["\n",(0,n.jsx)(i.p,{children:"Skim through the issues backlog; identify low-hanging and mostly new issues. From those, attempt to recreate issues based on the OP (Original Poster) description and ask questions if required. No question is a bad question!"}),"\n"]}),"\n"]}),"\n",(0,n.jsx)(i.h2,{id:"removal-of-triage-role",children:"Removal of Triage Role"}),"\n",(0,n.jsx)(i.p,{children:"There are a few cases where members can be removed from the triage role:"}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:["Breaking the ",(0,n.jsx)(i.a,{href:"/contributing/code-of-conduct",children:"Code of Conduct"})," or ",(0,n.jsx)(i.a,{href:"/contributing/introduction-to-contributing",children:"project contributor guidelines"}),"."]}),"\n",(0,n.jsx)(i.li,{children:"Abuse or misuse of the role as deemed by the Triage Team."}),"\n",(0,n.jsx)(i.li,{children:"Lack of participation for more than six months."}),"\n"]}),"\n",(0,n.jsx)(i.p,{children:"If any of these happen, we will discuss them as a part of the triage portion of the regular Triage Team meetings. If you have questions, feel free to contact any Triage Team members."}),"\n",(0,n.jsx)(i.h2,{id:"helpful-hints",children:"Helpful Hints"}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:["When reviewing the list of open issues, there are some common types and suggested actions:","\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"New/unattended issues or simple questions"}),": A good place to start."]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Hard bugs & ongoing discussions"}),": Feel free to chime in and help."]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Issues that imply gaps in the documentation"}),": Open PRs with changes or help the user to do so."]}),"\n"]}),"\n"]}),"\n",(0,n.jsx)(i.li,{children:"For recurring issues, it is helpful to create functional examples to demonstrate (publish as gists or a repo)."}),"\n",(0,n.jsxs)(i.li,{children:["Review and identify the maintainers. If necessary, mention one or more of them with ",(0,n.jsx)(i.code,{children:"@"})," if you are unsure what to do."]}),"\n",(0,n.jsx)(i.li,{children:"Ensure all your interactions are professional, welcoming, and respectful to the parties involved."}),"\n"]})]})}function u(e={}){const{wrapper:i}={...(0,t.R)(),...e.components};return i?(0,n.jsx)(i,{...e,children:(0,n.jsx)(c,{...e})}):c(e)}},8453:(e,i,s)=>{s.d(i,{R:()=>o,x:()=>a});var n=s(6540);const t={},r=n.createContext(t);function o(e){const i=n.useContext(r);return n.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function a(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),n.createElement(r.Provider,{value:i},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/88e6cb4a.8225ae81.js b/assets/js/88e6cb4a.8225ae81.js
deleted file mode 100644
index 66cd787f..00000000
--- a/assets/js/88e6cb4a.8225ae81.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunk_open_sauced_docs_opensauced_pizza=self.webpackChunk_open_sauced_docs_opensauced_pizza||[]).push([[9868],{1834:(e,i,s)=>{s.r(i),s.d(i,{assets:()=>l,contentTitle:()=>o,default:()=>u,frontMatter:()=>r,metadata:()=>a,toc:()=>d});var n=s(4848),t=s(8453);const r={id:"triage-guide",title:"Triage Guide",sidebar_label:"Triage Guide",keywords:["triage guide","Issue triage best practices","GitHub triage process","Pull request triage steps","Triage workflow tutorial","Effective issue management","Open source contribution triage","Triage for project maintainers","Streamlining triage efforts","Collaborative issue handling","Contributor triage assistance"]},o=void 0,a={id:"contributing/triage-guide",title:"Triage Guide",description:"Triage Process",source:"@site/docs/contributing/triage-guide.md",sourceDirName:"contributing",slug:"/contributing/triage-guide",permalink:"/contributing/triage-guide",draft:!1,unlisted:!1,editUrl:"https://github.com/open-sauced/docs.opensauced.pizza/edit/main/docs/contributing/triage-guide.md",tags:[],version:"current",lastUpdatedBy:"BekahHW",lastUpdatedAt:171701191e4,frontMatter:{id:"triage-guide",title:"Triage Guide",sidebar_label:"Triage Guide",keywords:["triage guide","Issue triage best practices","GitHub triage process","Pull request triage steps","Triage workflow tutorial","Effective issue management","Open source contribution triage","Triage for project maintainers","Streamlining triage efforts","Collaborative issue handling","Contributor triage assistance"]},sidebar:"docs",previous:{title:"Code of Conduct",permalink:"/contributing/code-of-conduct"},next:{title:"OpenSauced Maintainers Guide",permalink:"/contributing/opensauced-maintainers-guide/maintainers-guide"}},l={},d=[{value:"Triage Process",id:"triage-process",level:2},{value:"Adding Issue and PR Labels",id:"adding-issue-and-pr-labels",level:3},{value:"Labeling good first issue",id:"labeling-good-first-issue",level:3},{value:"Approaches and Best Practices for Getting Into Triage Contributions",id:"approaches-and-best-practices-for-getting-into-triage-contributions",level:2},{value:"Removal of Triage Role",id:"removal-of-triage-role",level:2},{value:"Helpful Hints",id:"helpful-hints",level:2}];function c(e){const i={a:"a",code:"code",h2:"h2",h3:"h3",li:"li",p:"p",strong:"strong",ul:"ul",...(0,t.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(i.h2,{id:"triage-process",children:"Triage Process"}),"\n",(0,n.jsxs)(i.p,{children:["When a new issue or pull request (PR) is opened, the issue will be labeled with ",(0,n.jsx)(i.code,{children:"needs triage"}),". At OpenSauced, our team functions as the triage team. Once a teammate is available, they can help ensure all the required information is provided."]}),"\n",(0,n.jsx)(i.h3,{id:"adding-issue-and-pr-labels",children:"Adding Issue and PR Labels"}),"\n",(0,n.jsx)(i.p,{children:"Depending on the issue or PR, there are several labels the triage team can add for further classification, as follows:"}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.code,{children:"needs triage"}),": This can be kept if the triager is unsure which next steps to take."]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.code,{children:"awaiting more info"}),": If more information has been requested from the author, apply this label."]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.code,{children:"question"}),": User questions that do not appear to be bugs or enhancements."]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.code,{children:"discuss"}),": Topics for discussion. It might end in an ",(0,n.jsx)(i.code,{children:"enhancement"})," or ",(0,n.jsx)(i.code,{children:"question"})," label."]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.code,{children:"bug"}),": Issues that present reasonable conviction there is a reproducible bug."]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.code,{children:"enhancement"}),": Issues that are found to be a reasonable candidate feature additions."]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.code,{children:"style"}),": Minor CSS or visual changes."]}),"\n"]}),"\n",(0,n.jsx)(i.p,{children:"In all cases, maintainers may close issues if they don't receive a timely response when further information is sought or when additional questions are asked."}),"\n",(0,n.jsxs)(i.h3,{id:"labeling-good-first-issue",children:["Labeling ",(0,n.jsx)(i.code,{children:"good first issue"})]}),"\n",(0,n.jsxs)(i.p,{children:["Issues labeled as ",(0,n.jsx)(i.code,{children:"good first issue"})," represent a curated list of easy contributions for new contributors. These issues are meant to help folks make their first contribution to open source and should not require excessive research or triaging on the contributor's part."]}),"\n",(0,n.jsxs)(i.p,{children:["All ",(0,n.jsx)(i.code,{children:"good first issue"})," should include one or more of the following:"]}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsx)(i.li,{children:"A solution."}),"\n",(0,n.jsx)(i.li,{children:"A suggestion for a solution."}),"\n",(0,n.jsx)(i.li,{children:"Links to components or in which issue occurs."}),"\n"]}),"\n",(0,n.jsx)(i.p,{children:"Please be noted:"}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:["Issues that ",(0,n.jsx)(i.code,{children:"needs triage"})," cannot be labeled as ",(0,n.jsx)(i.code,{children:"good first issues"}),"."]}),"\n",(0,n.jsxs)(i.li,{children:["It is better to have no ",(0,n.jsx)(i.code,{children:"good first issue"})," labeled issues than to have a ",(0,n.jsx)(i.code,{children:"good first issue"})," confusing enough to deter a contributor from contributing."]}),"\n"]}),"\n",(0,n.jsx)(i.h2,{id:"approaches-and-best-practices-for-getting-into-triage-contributions",children:"Approaches and Best Practices for Getting Into Triage Contributions"}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:["\n",(0,n.jsx)(i.p,{children:"Review the project's Contribution Guidelines if they are present. In a nutshell, commit to the community's standards and values."}),"\n"]}),"\n",(0,n.jsxs)(i.li,{children:["\n",(0,n.jsxs)(i.p,{children:["Review the documentation; for most projects, it is just the ",(0,n.jsx)(i.code,{children:"README.md"}),". Ensure you understand the key APIs, semantics, configurations, and use cases."]}),"\n"]}),"\n",(0,n.jsxs)(i.li,{children:["\n",(0,n.jsx)(i.p,{children:"Writing your own test apps to reaffirm your understanding of the key functions might be helpful. This may identify some gaps in documentation; record those as they might be good PRs to open."}),"\n"]}),"\n",(0,n.jsxs)(i.li,{children:["\n",(0,n.jsx)(i.p,{children:"Skim through the issues backlog; identify low-hanging and mostly new issues. From those, attempt to recreate issues based on the OP (Original Poster) description and ask questions if required. No question is a bad question!"}),"\n"]}),"\n"]}),"\n",(0,n.jsx)(i.h2,{id:"removal-of-triage-role",children:"Removal of Triage Role"}),"\n",(0,n.jsx)(i.p,{children:"There are a few cases where members can be removed from the triage role:"}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:["Breaking the ",(0,n.jsx)(i.a,{href:"/contributing/code-of-conduct",children:"Code of Conduct"})," or ",(0,n.jsx)(i.a,{href:"/contributing/introduction-to-contributing",children:"project contributor guidelines"}),"."]}),"\n",(0,n.jsx)(i.li,{children:"Abuse or misuse of the role as deemed by the Triage Team."}),"\n",(0,n.jsx)(i.li,{children:"Lack of participation for more than six months."}),"\n"]}),"\n",(0,n.jsx)(i.p,{children:"If any of these happen, we will discuss them as a part of the triage portion of the regular Triage Team meetings. If you have questions, feel free to contact any Triage Team members."}),"\n",(0,n.jsx)(i.h2,{id:"helpful-hints",children:"Helpful Hints"}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:["When reviewing the list of open issues, there are some common types and suggested actions:","\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"New/unattended issues or simple questions"}),": A good place to start."]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Hard bugs & ongoing discussions"}),": Feel free to chime in and help."]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Issues that imply gaps in the documentation"}),": Open PRs with changes or help the user to do so."]}),"\n"]}),"\n"]}),"\n",(0,n.jsx)(i.li,{children:"For recurring issues, it is helpful to create functional examples to demonstrate (publish as gists or a repo)."}),"\n",(0,n.jsxs)(i.li,{children:["Review and identify the maintainers. If necessary, mention one or more of them with ",(0,n.jsx)(i.code,{children:"@"})," if you are unsure what to do."]}),"\n",(0,n.jsx)(i.li,{children:"Ensure all your interactions are professional, welcoming, and respectful to the parties involved."}),"\n"]})]})}function u(e={}){const{wrapper:i}={...(0,t.R)(),...e.components};return i?(0,n.jsx)(i,{...e,children:(0,n.jsx)(c,{...e})}):c(e)}},8453:(e,i,s)=>{s.d(i,{R:()=>o,x:()=>a});var n=s(6540);const t={},r=n.createContext(t);function o(e){const i=n.useContext(r);return n.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function a(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),n.createElement(r.Provider,{value:i},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/908b0867.612e3e84.js b/assets/js/908b0867.612e3e84.js
deleted file mode 100644
index 13322dc5..00000000
--- a/assets/js/908b0867.612e3e84.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunk_open_sauced_docs_opensauced_pizza=self.webpackChunk_open_sauced_docs_opensauced_pizza||[]).push([[6755],{9939:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>c,contentTitle:()=>s,default:()=>u,frontMatter:()=>r,metadata:()=>a,toc:()=>h});var i=o(4848),n=o(8453);const r={id:"students-guide",title:"Students Guide to OpenSauced",sidebar_label:"Students Guide to OpenSauced",keywords:["contributors","guides","how to contribute to open source","students guide to open source"]},s=void 0,a={id:"opensauced-guides/students-guide/students-guide",title:"Students Guide to OpenSauced",description:"Introduction to OpenSauced for Students",source:"@site/docs/opensauced-guides/students-guide/students-guide.md",sourceDirName:"opensauced-guides/students-guide",slug:"/opensauced-guides/students-guide/",permalink:"/opensauced-guides/students-guide/",draft:!1,unlisted:!1,editUrl:"https://github.com/open-sauced/docs.opensauced.pizza/edit/main/docs/opensauced-guides/students-guide/students-guide.md",tags:[],version:"current",lastUpdatedBy:"BekahHW",lastUpdatedAt:171701191e4,frontMatter:{id:"students-guide",title:"Students Guide to OpenSauced",sidebar_label:"Students Guide to OpenSauced",keywords:["contributors","guides","how to contribute to open source","students guide to open source"]},sidebar:"docs",previous:{title:"How to Translate Open Source Contributions into Career Opportunities",permalink:"/opensauced-guides/job-seekers-guide/how-to-translate-open-source-contributions-into-career-opportunities"},next:{title:"Maintainers Guide to OpenSauced",permalink:"/maintainers/maintainers-guide-to-open-sauced"}},c={},h=[{value:"Introduction to OpenSauced for Students",id:"introduction-to-opensauced-for-students",level:2},{value:"Getting Started",id:"getting-started",level:2},{value:"Creating Your Profile",id:"creating-your-profile",level:2},{value:"Your Profile",id:"your-profile",level:3},{value:"Your Dev Card",id:"your-dev-card",level:3},{value:"Explore: Finding Your Next Open Source Project",id:"explore-finding-your-next-open-source-project",level:2},{value:"Highlights: Connecting and Recognizing Contributions",id:"highlights-connecting-and-recognizing-contributions",level:2},{value:"Creating a New Highlight",id:"creating-a-new-highlight",level:3},{value:"Writing an Effective Highlight",id:"writing-an-effective-highlight",level:3},{value:"Highlighting Issues",id:"highlighting-issues",level:4},{value:"Highlighting PRs",id:"highlighting-prs",level:4},{value:"Highlighting Blog Posts",id:"highlighting-blog-posts",level:4},{value:"Creating Your Workspace",id:"creating-your-workspace",level:2},{value:"Creating a New Workspace",id:"creating-a-new-workspace",level:3},{value:"Adding Repositories to Your Workspace",id:"adding-repositories-to-your-workspace",level:3},{value:"Navigating Your Workspace",id:"navigating-your-workspace",level:3},{value:"Repositories Dashboard",id:"repositories-dashboard",level:4},{value:"Why Create a Workspace?",id:"why-create-a-workspace",level:3},{value:"Repository Insights: Connecting Your Repositories",id:"repository-insights-connecting-your-repositories",level:2},{value:"Why Create a Repository Insights Page?",id:"why-create-a-repository-insights-page",level:3},{value:"Creating a New Repository Insight Page",id:"creating-a-new-repository-insight-page",level:3},{value:"Using Your Repository Insights Page",id:"using-your-repository-insights-page",level:3},{value:"Repositories Dashboard",id:"repositories-dashboard-1",level:4},{value:"Contributors",id:"contributors",level:4},{value:"Activity",id:"activity",level:4},{value:"Contributor Insights: Connecting with Contributors",id:"contributor-insights-connecting-with-contributors",level:2},{value:"What Can You Do with Contributor Insights?",id:"what-can-you-do-with-contributor-insights",level:3},{value:"Creating a New Contributor Insights Page",id:"creating-a-new-contributor-insights-page",level:3},{value:"Using Your Contributor Insights Page",id:"using-your-contributor-insights-page",level:2},{value:"Overview",id:"overview",level:3},{value:"Activity",id:"activity-1",level:3},{value:"Highlights",id:"highlights",level:3},{value:"Takeaways",id:"takeaways",level:2},{value:"Conclusion",id:"conclusion",level:2}];function l(e){const t={a:"a",admonition:"admonition",h2:"h2",h3:"h3",h4:"h4",img:"img",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,n.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.h2,{id:"introduction-to-opensauced-for-students",children:"Introduction to OpenSauced for Students"}),"\n",(0,i.jsx)(t.p,{children:"Welcome to the wonderful world of open source. As a student, you'll find countless opportunities to contribute to projects, collaborate across global projects, and enhance your resume through meaningful contributions. You can use OpenSauced as a tool to enhance your open source journey by helping you to find interesting repositories that match your academic and personal interests, document your journey, learn from the community, and showcase your growth."}),"\n",(0,i.jsxs)(t.p,{children:["In this guide, you will learn how to use OpenSauced features like your personal ",(0,i.jsx)(t.a,{href:"/features/dev-card",children:"Dev Card"}),", ",(0,i.jsx)(t.a,{href:"/features/highlights",children:"Highlights"}),", ",(0,i.jsx)(t.a,{href:"/features/contributor-insights",children:"Contributor Insights"}),", and ",(0,i.jsx)(t.a,{href:"/features/repo-insights",children:"Repository Insights"})," to showcase your open source work and build connections to help you meet your next goals."]}),"\n",(0,i.jsx)(t.h2,{id:"getting-started",children:"Getting Started"}),"\n",(0,i.jsxs)(t.p,{children:["To get started, you will need to create an account on OpenSauced. You can do this by visiting ",(0,i.jsx)(t.a,{href:"https://app.opensauced.pizza",children:"app.opensauced.pizza"}),' and clicking the "Connect with GitHub" button. You will be prompted to sign in with your GitHub account. Once you have signed in, you will be redirected to the OpenSauced dashboard. The best place to get started is by creating your profile.']}),"\n",(0,i.jsx)(t.h2,{id:"creating-your-profile",children:"Creating Your Profile"}),"\n",(0,i.jsx)(t.p,{children:"Creating your profile is a great way to showcase your open source contributions, connect with other contributors and maintainers, and share with your classmates, communities, and connections. Here are some steps to help you get started:"}),"\n",(0,i.jsxs)(t.ol,{children:["\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsx)(t.p,{children:'After creating your account, navigate to "Settings."'}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.img,{alt:"settings",src:o(1102).A+"",width:"746",height:"178"})}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsx)(t.p,{children:"Once there, you will be asked to add your name, bio, links to your social media accounts, timezone, and other forms of contact information."}),"\n",(0,i.jsx)(t.admonition,{type:"tip",children:(0,i.jsx)(t.p,{children:"Don't forget to add your personal site, GitHub Sponsors URL, and LinkedIn so people can connect with you and learn more about your work."})}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsx)(t.p,{children:'In the "Interests" section, select the various programming languages and topics you are interested in. Setting them up helps us recommend open source projects that fit your interests.'}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsx)(t.p,{children:"Manage your email preferences."}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(t.h3,{id:"your-profile",children:"Your Profile"}),"\n",(0,i.jsx)(t.p,{children:"Your profile is a great resource for showcasing your contributions and sharing your open source work with others."}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.img,{alt:"your profile",src:o(6726).A+"",width:"955",height:"994"})}),"\n",(0,i.jsxs)(t.p,{children:['On your profile, you will see the "Highlights" tab, which you can learn more about ',(0,i.jsx)(t.a,{href:"#highlights-connecting-and-recognizing-contributions",children:"in this section"}),". Other tabs you may find useful on your profile are:"]}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Contributions"}),": This tab includes a graph showing the number of PRs you have opened, ",(0,i.jsx)(t.a,{href:"/welcome/glossary#pr-velocity",children:"the velocity of your PRs"}),', and the number of repositories you have contributed to in the last thirty days. Underneath the graph is a "Latest PRs" chart, which shows a list of current and recent PRs. This tab is helpful if you want to showcase a steady and consistent open source contribution experience.']}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Recommendations"}),': This tab includes a list of open source projects that are chosen based on the programming languages you picked in the "Interests" section of your public profile. It is useful if you\'re looking for new projects to contribute to.']}),"\n"]}),"\n",(0,i.jsx)(t.admonition,{type:"tip",children:(0,i.jsx)(t.p,{children:"To get the full benefit of your profile, share it on social media, include a link to it on your resume, LinkedIn, your GitHub Readme, and your personal website to showcase your most up-to-date open source contributions."})}),"\n",(0,i.jsx)(t.h3,{id:"your-dev-card",children:"Your Dev Card"}),"\n",(0,i.jsxs)(t.p,{children:["Another fun way to share your open source contributions is through your ",(0,i.jsx)(t.a,{href:"/features/dev-card",children:"Dev Card"}),". Your Dev Card is a visual representation of your open source contributions. It includes your profile picture, name, bio, and the number of your latest contributions."]}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.img,{alt:"dev card",src:o(3707).A+"",width:"940",height:"658"})}),"\n",(0,i.jsx)(t.h2,{id:"explore-finding-your-next-open-source-project",children:"Explore: Finding Your Next Open Source Project"}),"\n",(0,i.jsx)(t.p,{children:'The "Explore" tab is a great place to start if you\'re looking for a new open source project to contribute to. Here, you can find a list of open source projects and filter them by language, top repos, recent, most active, and more.'}),"\n",(0,i.jsx)(t.p,{children:"Once you've selected your filters, you'll be able to see the contributors, spam, and activity levels of the repository. Understanding a repository's activity level and PR velocity can help you determine if it's a good fit for you to contribute to and what to expect when you submit a PR."}),"\n",(0,i.jsxs)(t.p,{children:['For example, if you wanted to look for a JavaScript project to contribute to, you would select "JavaScript" from the language dropdown and "Most Active" from the filter dropdown to see the most active JavaScript projects on GitHub. If you want to keep track of the repositories you\'re interested in contributing to, you can select and add them to a ',(0,i.jsx)(t.a,{href:"/features/repo-insights",children:"Repository Insights Page"})," or your ",(0,i.jsx)(t.a,{href:"/features/workspaces",children:"Workspace"}),"."]}),"\n",(0,i.jsx)(t.h2,{id:"highlights-connecting-and-recognizing-contributions",children:"Highlights: Connecting and Recognizing Contributions"}),"\n",(0,i.jsxs)(t.p,{children:["Leveraging OpenSauced's ",(0,i.jsx)(t.a,{href:"/features/highlights",children:"Highlights"})," feature is a great way to showcase your valuable contributions to open source projects. You can curate and share your achievements and milestones, bringing visibility to your hard work."]}),"\n",(0,i.jsx)(t.p,{children:"The Highlights feature allows you to:"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:"talk about issues that you raised,"}),"\n",(0,i.jsx)(t.li,{children:"share blog posts that you've written,"}),"\n",(0,i.jsx)(t.li,{children:"display Pull Requests that showcase your contributions."}),"\n"]}),"\n",(0,i.jsx)(t.h3,{id:"creating-a-new-highlight",children:"Creating a New Highlight"}),"\n",(0,i.jsx)(t.p,{children:"There are two ways to create a new highlight:"}),"\n",(0,i.jsxs)(t.ol,{children:["\n",(0,i.jsx)(t.li,{children:"Paste the URL to your PR, issue, or blog post (shown in blue below)."}),"\n",(0,i.jsx)(t.li,{children:"Choose from a list of suggestions (shown in orange below)."}),"\n"]}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.img,{alt:"highlight suggestions",src:o(7718).A+"",width:"626",height:"633"})}),"\n",(0,i.jsx)(t.admonition,{type:"note",children:(0,i.jsx)(t.p,{children:"If you're adding a blog post, you'll need to associate it to a repository by clicking the \"Add a repo\" button."})}),"\n",(0,i.jsx)(t.p,{children:"Finally, it's time to add the details of your highlight. You can write the description yourself or use the auto-summarize button to generate one."}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.img,{alt:"gif of creating a highlight",src:o(9001).A+"",width:"2294",height:"1066"})}),"\n",(0,i.jsx)(t.h3,{id:"writing-an-effective-highlight",children:"Writing an Effective Highlight"}),"\n",(0,i.jsx)(t.p,{children:"Sharing the story of your hard work is an opportunity to connect with the reader, which could include potential collaborators, other contributors, maintainers, or anyone on OpenSauced. Here are some tips to help you write effective stories for your highlights:"}),"\n",(0,i.jsx)(t.h4,{id:"highlighting-issues",children:"Highlighting Issues"}),"\n",(0,i.jsxs)(t.ol,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Share your motivation"}),': Briefly explain why you raised the issue. For example, "I\'m passionate about improving accessibility because I believe everyone should have equal access to information."']}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Summarize the issue"}),": Briefly describe the issue you wrote so your readers have context. For example, \"I raised an issue to add alt text to images in the project's 'About Us' page.\""]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Describe the impact:"}),' Briefly state how the resolution of the issue will improve the project. For example, "This will help people who use screen readers understand the content better."']}),"\n"]}),"\n",(0,i.jsx)(t.h4,{id:"highlighting-prs",children:"Highlighting PRs"}),"\n",(0,i.jsxs)(t.ol,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Describe the PR"}),': Start with a clear summary of what your PR accomplishes. For example, "I added a new feature to the project\'s Chrome Extension that allows users to summarize content."']}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Highlight your solution and its impact"}),': Briefly describe the solution, any challenges you faced, or any part of the PR you\'re particularly proud of. For example, "Initially, I faced challenges with the API, but I was able to resolve them using a different endpoint."']}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Reflect on your experience"}),': Mention what you learned from working on the PR. For example, "I learned a lot about the Chrome Extension API and how to use it to create new features."']}),"\n"]}),"\n",(0,i.jsx)(t.h4,{id:"highlighting-blog-posts",children:"Highlighting Blog Posts"}),"\n",(0,i.jsxs)(t.ol,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Describe the topic"}),": Begin with an interesting blog post summary to help others understand your writing."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Discuss the inspiration"}),": Explain why you wrote this blog post. Is it to guide others on improving their coding skills, raise awareness about an issue in the tech community, or display your progress in learning a new programming language?"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"End with a call-to-action"}),": Encourage others to read and engage with the post."]}),"\n"]}),"\n",(0,i.jsx)(t.h2,{id:"creating-your-workspace",children:"Creating Your Workspace"}),"\n",(0,i.jsx)(t.p,{children:"As a student working on multiple projects or contributing to various open source repositories, keeping track of progress, goals, and collaboration can be daunting. To keep track of the repositories that are most important to you or repositories that you're working on with a team, OpenSauced Workspaces can be your go-to tool for organizing and understanding your open source journey."}),"\n",(0,i.jsx)(t.p,{children:"Your Workspace helps you to:"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Understand projects at a high level"}),": Being able to look at all the repositories that are important to you and understand them at a high level makes it easier for you to share this information and collaborate with others."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Enhance team collaboration"}),": If you're working with a group, you can keep track of what everyone is working on. This transparency is key to teamwork and support, whether you're setting goals for a class project, contributing to a group assignment, or working together for accountability."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Deepen your project insight"}),": Understanding the underlying activities of the projects you're tracking helps you to understand their progress, health, and the community of student contributors you're part of."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Celebrate and communicate your achievements"}),": When it's time to talk about your experience, having analytics on the projects you worked on allows you to showcase your contributions, acknowledge the efforts of your peers, and clearly communicate the hard work invested."]}),"\n"]}),"\n",(0,i.jsx)(t.p,{children:"Workspaces offer a centralized platform. It's perfect for students to organize, track, and analyze the open source projects they're working on."}),"\n",(0,i.jsx)(t.h3,{id:"creating-a-new-workspace",children:"Creating a New Workspace"}),"\n",(0,i.jsxs)(t.p,{children:["To create a workspace, start by accessing the ",(0,i.jsx)(t.strong,{children:"Workspace switcher"})," in the sidebar. From there, you can create a new workspace or view an existing one."]}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.img,{alt:"workspace switcher",src:o(8164).A+"",width:"1877",height:"888"})}),"\n",(0,i.jsx)("br",{}),"\n",(0,i.jsx)(t.admonition,{type:"note",children:(0,i.jsx)(t.p,{children:'Whenever you select "Home", you\'ll be taken to the last workspace you opened.'})}),"\n",(0,i.jsx)(t.h3,{id:"adding-repositories-to-your-workspace",children:"Adding Repositories to Your Workspace"}),"\n",(0,i.jsx)(t.p,{children:"If you're creating a new workspace, you'll have the option to add repositories at the time of creation."}),"\n",(0,i.jsx)(t.p,{children:'Start by creating a workspace name, then click "Add repositories". You\'ll have three options for adding repositories:'}),"\n",(0,i.jsxs)(t.ol,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Search for Repositories"}),": Use our search tool by adding an organization name, followed by the repository name, and add them to your workspace."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Import a GitHub Organization"}),": Connect to your GitHub organizations to create a workspace from an organization. (If you're having trouble with this, see the \"",(0,i.jsx)(t.a,{href:"/welcome/faqs#sync-your-github-team",children:"Sync Your GitHub Team"}),'" section in our FAQs.)']}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Import Repositories"}),": Paste a list of repositories to add to your workspace."]}),"\n"]}),"\n",(0,i.jsx)(t.p,{children:"Once your repositories are added, you'll be able to see them in your repository dashboard. You can also edit your workspace to add or remove repositories anytime."}),"\n",(0,i.jsx)(t.h3,{id:"navigating-your-workspace",children:"Navigating Your Workspace"}),"\n",(0,i.jsx)(t.p,{children:"Once your repositories are connected, you'll enter your Workspace dashboard. In your workspace dashboards, you can create, view, and manage your workspaces."}),"\n",(0,i.jsx)(t.h4,{id:"repositories-dashboard",children:"Repositories Dashboard"}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.img,{alt:"Workspaces",src:o(389).A+"",width:"3200",height:"1800"})}),"\n",(0,i.jsx)(t.p,{children:"Within the repositories dashboard, you can view the following metrics, which are over a period of thirty days by default:"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Pull Requests"}),": This includes the total number of opened and merged pull requests for the repositories in your workspace and the velocity of pull requests being merged."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Issues"}),": This includes the total number of opened and closed issues for the repositories in your workspace and the velocity of issues being closed."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Engagement"}),": This includes the total number of stars, forks, and activity ratio for the repositories in your workspace."]}),"\n"]}),"\n",(0,i.jsx)(t.h3,{id:"why-create-a-workspace",children:"Why Create a Workspace?"}),"\n",(0,i.jsx)(t.p,{children:"There are many reasons to create a workspace. Here are a few:"}),"\n",(0,i.jsxs)(t.ol,{children:["\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"Targeted Contributions"}),": Workspaces allow you to create a list of repositories you are interested in or actively contributing to, which can help you stay focused on projects that align with your interests or goals."]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"Job Search Organization"}),": You can create workspaces dedicated to tracking open source projects from companies known for hiring contributors, which can help you find potential job opportunities."]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"Coursework Management"}),": For managing group open source projects or individual assignments, a workspace can be used to organize repositories that are part of the assignments, keeping all relevant repositories in one accessible location."]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"Skill-Specific Exploration"}),": You can use workspaces to follow repositories that help you build specific skills or understand certain technologies, creating a tailored learning environment that aligns with your career path or focus."]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"Community Engagement Tracking"}),": By adding repositories you're interested in, you can monitor and engage with the communities behind them. This allows you to understand the dynamics of open source collaboration, which is invaluable for both personal and professional networking."]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(t.h2,{id:"repository-insights-connecting-your-repositories",children:"Repository Insights: Connecting Your Repositories"}),"\n",(0,i.jsxs)(t.p,{children:["OpenSauced ",(0,i.jsx)(t.a,{href:"/features/repo-insights",children:"Repository Insights"})," allows you to track open source projects you are interested in. You can use Repository Insights Pages to track repositories' growth, analyze work, and connect with others."]}),"\n",(0,i.jsx)(t.h3,{id:"why-create-a-repository-insights-page",children:"Why Create a Repository Insights Page?"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"To track projects you're working on"}),": Tracking projects you're working on can help you stay up-to-date with the latest activity and trends and connect with other contributors."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"To identify potential projects to contribute to"}),': If you\'re looking for a new project to contribute to, you can use the Repository Insights feature to track active projects that are looking for contributors. You can use the "Explore" tab to find new projects to contribute to and track them with your Repository Insights page.']}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"To network and engage with the community"}),': Finding people to work and connect with can be challenging. You can connect with your network through the feature\'s "Contributors" tab.']}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"To track the activity of a topic you're interested in"}),": Keeping up with the latest trends and activity in a particular topic can be challenging. You can use the Repository Insights feature to track the activity of a specific topic and find new projects to contribute to. For example, you can create a ",(0,i.jsx)(t.a,{href:"https://app.opensauced.pizza/pages/BekahHW/1055/dashboard",children:"Repository Insight Page for Active AI Repositories"}),"."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"To track the activity of your favorite programming languages"}),": If you're interested in tracking the activity of your favorite programming languages, you can use the Repository Insights feature to track the open source projects that are using them."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"To aid in the job search"}),": If you're looking for a job, you can use the Repository Insights feature to track the activity of the organizations you're interested in working on. This can help you understand the activity level of the repositories and the types of contributions being made, and even identify which company you want to contribute to."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Curating collections for interest groups"}),": You can curate and share repositories focusing on sectors and programming languages that interest you."]}),"\n"]}),"\n",(0,i.jsx)(t.p,{children:"Within your workspace, you can create new lists of repositories called Repository Insight Pages."}),"\n",(0,i.jsx)(t.h3,{id:"creating-a-new-repository-insight-page",children:"Creating a New Repository Insight Page"}),"\n",(0,i.jsx)(t.p,{children:'To track the repositories, click the "+" next to "Insights" in the sidebar, then select "New Repository Insight." You will be redirected to a page where you can create your new Repository Insight Page.'}),"\n",(0,i.jsx)(t.p,{children:"There are two ways to add repositories to your Repository Insight Page:"}),"\n",(0,i.jsxs)(t.ol,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Sync GitHub organization"}),": Syncing your GitHub organizations is a good idea if you want to keep track of their open source project activities and trends."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Connect individual repositories"}),": Connecting individual repositories is a good idea if you want to keep track of the contributions of a specific repository or group of repositories."]}),"\n"]}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.img,{alt:"sync Repository Insights gif",src:o(709).A+"",width:"960",height:"543"})}),"\n",(0,i.jsx)(t.h3,{id:"using-your-repository-insights-page",children:"Using Your Repository Insights Page"}),"\n",(0,i.jsx)(t.p,{children:"Once you have connected your repositories, you will be redirected to your Repository Insight Page. Here, you will see a dashboard with an overview of the repositories and the contributors who have contributed to them."}),"\n",(0,i.jsx)(t.p,{children:"There are three tabs that provide you with more information on these repositories:"}),"\n",(0,i.jsx)(t.h4,{id:"repositories-dashboard-1",children:"Repositories Dashboard"}),"\n",(0,i.jsx)(t.p,{children:"If you're looking for an active project to contribute to, this tab can help you. It contains information such as activity levels, PR overview, PR velocity, spam PRs, contributors, and activity stats over the last 30 days. This information is also a good way to connect with others on the project or where to find support."}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.img,{alt:"repositories tab",src:o(4394).A+"",width:"1148",height:"796"})}),"\n",(0,i.jsx)(t.h4,{id:"contributors",children:"Contributors"}),"\n",(0,i.jsx)(t.p,{children:'The "Contributors" tab allows you to view more detailed information about other contributors, including activity levels, the number of repositories they contributed to, the date of their last contribution, their most used language, their time zone, the number of contributions, and their activity stats over the last 30 days. This can be a great way to find others to collaborate with or to reach out to for support.'}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.img,{alt:"contributors insight list",src:o(9333).A+"",width:"1212",height:"628"})}),"\n",(0,i.jsx)(t.admonition,{type:"tip",children:(0,i.jsx)(t.p,{children:"Want to learn more about your peers? You can select and add them to a Contributor Insight Page."})}),"\n",(0,i.jsx)(t.h4,{id:"activity",children:"Activity"}),"\n",(0,i.jsx)(t.p,{children:"The \"Activity\" tab shows a graph of the last time each contributor created their PR and how many lines of code they've touched. It also provides more detailed information on each contributor when you hover over their image, including their latest PRs and repositories they've contributed to. Clicking their image will bring you to their profile on OpenSauced."}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.img,{alt:"activity graph",src:o(3046).A+"",width:"1592",height:"791"})}),"\n",(0,i.jsx)(t.p,{children:"Beyond understanding repositories, you may want to get insights into other contributors to help you learn more about how others are contributing to open source. One way to do that is through Contributor Insights."}),"\n",(0,i.jsx)(t.h2,{id:"contributor-insights-connecting-with-contributors",children:"Contributor Insights: Connecting with Contributors"}),"\n",(0,i.jsxs)(t.p,{children:["The ",(0,i.jsx)(t.a,{href:"/features/contributor-insights",children:"Contributor Insights"})," feature helps you connect with other contributors or learn more about what others are up to in open source. With this feature, you can categorize, watch, and check out different groups of contributors within open source projects."]}),"\n",(0,i.jsx)(t.h3,{id:"what-can-you-do-with-contributor-insights",children:"What Can You Do with Contributor Insights?"}),"\n",(0,i.jsx)(t.p,{children:"There are many things you can do with this feature, but here are some ideas to get you started:"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Track personal contributions"}),": If you create a list of your personal contributions, you can track them and see how you're doing over time, as well as get a breakdown of the type of contributions you're making, including commits, created PRs, reviewed PRs, and created issues."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Learn about what other contributors are doing in open source"}),": You can learn where other contributors are contributing, what they're working on, and how active they are in the open source community."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"See who's using the OpenSauced Highlights feature"}),": You can see who's using the Highlights feature and show them support by giving an emoji reaction."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Track contributors for job opportunities"}),": If you're looking for a job, you can track the activity of the contributors you're interested in working with. This helps you understand the activity level of the repositories and the types of contributions being made, and you can even identify which company you want to contribute to."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Track your classmates or peers"}),": If you're working with a group, you can track the activity of your classmates or peers to see what they're working on and how active they are in the open source community."]}),"\n"]}),"\n",(0,i.jsx)(t.h3,{id:"creating-a-new-contributor-insights-page",children:"Creating a New Contributor Insights Page"}),"\n",(0,i.jsxs)(t.ol,{children:["\n",(0,i.jsx)(t.li,{children:'Click the "+" next to "Insights" in your sidebar.'}),"\n",(0,i.jsx)(t.li,{children:'Select "New Contributor Insight" to start a new Contributor Insight Page.'}),"\n",(0,i.jsx)(t.li,{children:"Give your page a name."}),"\n",(0,i.jsx)(t.li,{children:"Add contributors to your page by searching for their GitHub username, syncing your GitHub Team, or importing your GitHub Following."}),"\n",(0,i.jsx)(t.li,{children:"Once your page is created, you can edit and choose to make it public or private. By default, it is set to public. To create a private page, you can upgrade your account to a paid plan."}),"\n"]}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.img,{alt:"contribution sync gif",src:o(8896).A+"",width:"1324",height:"1030"})}),"\n",(0,i.jsx)(t.h2,{id:"using-your-contributor-insights-page",children:"Using Your Contributor Insights Page"}),"\n",(0,i.jsx)(t.p,{children:"Once you have created your list, you will be redirected to your Contributor Insights Page. Here, you will see a dashboard with an overview of the contributors."}),"\n",(0,i.jsx)(t.p,{children:"There are three tabs that provide you with more information on these repositories:"}),"\n",(0,i.jsx)(t.h3,{id:"overview",children:"Overview"}),"\n",(0,i.jsx)(t.p,{children:'The "Overview" tab gives you a high-level view of the contributors in your list, including the total number of commits in the last 30 days and the types of contributors: Active, New, and Alumni.'}),"\n",(0,i.jsx)(t.h3,{id:"activity-1",children:"Activity"}),"\n",(0,i.jsx)(t.p,{children:'The "Activity" tab gives you a graph view with more detailed information on each contributor, including the type of activity, repositories they\'ve contributed to, and how they compare to each other.'}),"\n",(0,i.jsx)(t.p,{children:"You can filter your Contributor Insight Page by All Contributors, Active Contributors, New Contributors, and Alumni Contributors."}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.img,{alt:"list graph",src:o(9834).A+"",width:"1263",height:"781"})}),"\n",(0,i.jsx)(t.h3,{id:"highlights",children:"Highlights"}),"\n",(0,i.jsx)(t.p,{children:'The "Highlights" tab gives you a list of the highlights that the contributors listed on your page have created. This is a great way to see what other contributors are up to and to show them support.'}),"\n",(0,i.jsx)(t.h2,{id:"takeaways",children:"Takeaways"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Create Your Profile"}),": Creating your profile is a great way to display your open source contributions, connect with other contributors and maintainers, and share during a job search."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Explore"}),': The "Explore" tab is a great place to find new open source projects to contribute to.']}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Highlights"}),": Leveraging OpenSauced's Highlights feature is a great way for you to showcase your valuable contributions to open source projects."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Repository Insights"}),": OpenSauced Repository Insights feature allows you to track open source projects you are interested in."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Contributor Insights"}),": The Contributor Insights feature helps you understand other contributors or track your own work in open source."]}),"\n"]}),"\n",(0,i.jsx)(t.h2,{id:"conclusion",children:"Conclusion"}),"\n",(0,i.jsx)(t.p,{children:"Embarking on your open source journey with OpenSauced opens up a world of learning and development opportunities. It's a chance to apply your knowledge to real-world projects, collaborate with a global community, and build a portfolio that stands out to educators and employers alike. We're excited to support you on this journey and can't wait to see the contributions you'll make and the milestones you'll achieve. If you have any questions or need assistance, our community is here to help you navigate your path in open source."}),"\n",(0,i.jsx)(t.p,{children:"Here are some other resources you might find helpful in your journey:"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.a,{href:"/community/100-days-of-oss",children:"100 Days of OSS"})}),"\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.a,{href:"https://intro.opensauced.pizza/#/",children:"Intro to Open Source Course"})}),"\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.a,{href:"https://opensauced.pizza/blog/resume-driven-contributions",children:"Resume Driven Contributions"})}),"\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.a,{href:"https://opensauced.pizza/blog/stop-burning-out-maintainers-an-empathetic-guide-for-contributors",children:"Stop Burning Out Maintainers: An Empathetic Guide for Contributors"})}),"\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.a,{href:"https://gh.io/AApppma",children:"GitHub Student Benefits"})}),"\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.a,{href:"https://gh.io/AApphwi",children:"GitHub Student Developer Pack"})}),"\n"]})]})}function u(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},8896:(e,t,o)=>{o.d(t,{A:()=>i});const i=o.p+"assets/images/contributors-sync-list-b427c1971ecbd190a472a1a061bf63a6.gif"},9001:(e,t,o)=>{o.d(t,{A:()=>i});const i=o.p+"assets/images/highlight-e3a2da2446fe91467a31d225755bf40a.gif"},709:(e,t,o)=>{o.d(t,{A:()=>i});const i=o.p+"assets/images/insight-page-demo-cc2291df69361b2d476ccffcdbd1ee25.gif"},3707:(e,t,o)=>{o.d(t,{A:()=>i});const i=o.p+"assets/images/a-dev-card-f7b01f48467c20d93ddb9814e8e54918.png"},3046:(e,t,o)=>{o.d(t,{A:()=>i});const i=o.p+"assets/images/activity-repos-insights-3734baf3ab38356a4de96d43dde41a3d.png"},9333:(e,t,o)=>{o.d(t,{A:()=>i});const i=o.p+"assets/images/contributors-insights-1bc09dd6a32c3a16eba8b63ec351157f.png"},7718:(e,t,o)=>{o.d(t,{A:()=>i});const i=o.p+"assets/images/highlights-fcc750f036bb2ea7c11166c8338d7f6c.png"},9834:(e,t,o)=>{o.d(t,{A:()=>i});const i=o.p+"assets/images/list-graph-e2718b080f8d3af7e28011a6f064f46e.png"},6726:(e,t,o)=>{o.d(t,{A:()=>i});const i=o.p+"assets/images/profile-d4fae85bbb516b6a5b5837a3d137c223.png"},4394:(e,t,o)=>{o.d(t,{A:()=>i});const i=o.p+"assets/images/repos-insights-2db5d8c668cee2f528f47ae986d664c7.png"},1102:(e,t,o)=>{o.d(t,{A:()=>i});const i=o.p+"assets/images/settings-748558f026c2a0b1c23cbb3648bf3a05.png"},8164:(e,t,o)=>{o.d(t,{A:()=>i});const i=o.p+"assets/images/workspace-switcher-b2400ec5c309a762f822268b44779930.png"},389:(e,t,o)=>{o.d(t,{A:()=>i});const i=o.p+"assets/images/workspace-644e59bed496d2a0df7502aaa833129e.png"},8453:(e,t,o)=>{o.d(t,{R:()=>s,x:()=>a});var i=o(6540);const n={},r=i.createContext(n);function s(e){const t=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:s(e.components),i.createElement(r.Provider,{value:t},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/908b0867.632d7d3e.js b/assets/js/908b0867.632d7d3e.js
new file mode 100644
index 00000000..038bd5f3
--- /dev/null
+++ b/assets/js/908b0867.632d7d3e.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunk_open_sauced_docs_opensauced_pizza=self.webpackChunk_open_sauced_docs_opensauced_pizza||[]).push([[6755],{9939:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>c,contentTitle:()=>s,default:()=>u,frontMatter:()=>r,metadata:()=>a,toc:()=>h});var i=o(4848),n=o(8453);const r={id:"students-guide",title:"Students Guide to OpenSauced",sidebar_label:"Students Guide to OpenSauced",keywords:["contributors","guides","how to contribute to open source","students guide to open source"]},s=void 0,a={id:"opensauced-guides/students-guide/students-guide",title:"Students Guide to OpenSauced",description:"Introduction to OpenSauced for Students",source:"@site/docs/opensauced-guides/students-guide/students-guide.md",sourceDirName:"opensauced-guides/students-guide",slug:"/opensauced-guides/students-guide/",permalink:"/opensauced-guides/students-guide/",draft:!1,unlisted:!1,editUrl:"https://github.com/open-sauced/docs.opensauced.pizza/edit/main/docs/opensauced-guides/students-guide/students-guide.md",tags:[],version:"current",lastUpdatedBy:"BekahHW",lastUpdatedAt:1717170876e3,frontMatter:{id:"students-guide",title:"Students Guide to OpenSauced",sidebar_label:"Students Guide to OpenSauced",keywords:["contributors","guides","how to contribute to open source","students guide to open source"]},sidebar:"docs",previous:{title:"How to Translate Open Source Contributions into Career Opportunities",permalink:"/opensauced-guides/job-seekers-guide/how-to-translate-open-source-contributions-into-career-opportunities"},next:{title:"Maintainers Guide to OpenSauced",permalink:"/maintainers/maintainers-guide-to-open-sauced"}},c={},h=[{value:"Introduction to OpenSauced for Students",id:"introduction-to-opensauced-for-students",level:2},{value:"Getting Started",id:"getting-started",level:2},{value:"Creating Your Profile",id:"creating-your-profile",level:2},{value:"Your Profile",id:"your-profile",level:3},{value:"Your Dev Card",id:"your-dev-card",level:3},{value:"Explore: Finding Your Next Open Source Project",id:"explore-finding-your-next-open-source-project",level:2},{value:"Highlights: Connecting and Recognizing Contributions",id:"highlights-connecting-and-recognizing-contributions",level:2},{value:"Creating a New Highlight",id:"creating-a-new-highlight",level:3},{value:"Writing an Effective Highlight",id:"writing-an-effective-highlight",level:3},{value:"Highlighting Issues",id:"highlighting-issues",level:4},{value:"Highlighting PRs",id:"highlighting-prs",level:4},{value:"Highlighting Blog Posts",id:"highlighting-blog-posts",level:4},{value:"Creating Your Workspace",id:"creating-your-workspace",level:2},{value:"Creating a New Workspace",id:"creating-a-new-workspace",level:3},{value:"Adding Repositories to Your Workspace",id:"adding-repositories-to-your-workspace",level:3},{value:"Navigating Your Workspace",id:"navigating-your-workspace",level:3},{value:"Repositories Dashboard",id:"repositories-dashboard",level:4},{value:"Why Create a Workspace?",id:"why-create-a-workspace",level:3},{value:"Repository Insights: Connecting Your Repositories",id:"repository-insights-connecting-your-repositories",level:2},{value:"Why Create a Repository Insights Page?",id:"why-create-a-repository-insights-page",level:3},{value:"Creating a New Repository Insight Page",id:"creating-a-new-repository-insight-page",level:3},{value:"Using Your Repository Insights Page",id:"using-your-repository-insights-page",level:3},{value:"Repositories Dashboard",id:"repositories-dashboard-1",level:4},{value:"Contributors",id:"contributors",level:4},{value:"Activity",id:"activity",level:4},{value:"Contributor Insights: Connecting with Contributors",id:"contributor-insights-connecting-with-contributors",level:2},{value:"What Can You Do with Contributor Insights?",id:"what-can-you-do-with-contributor-insights",level:3},{value:"Creating a New Contributor Insights Page",id:"creating-a-new-contributor-insights-page",level:3},{value:"Using Your Contributor Insights Page",id:"using-your-contributor-insights-page",level:2},{value:"Overview",id:"overview",level:3},{value:"Activity",id:"activity-1",level:3},{value:"Highlights",id:"highlights",level:3},{value:"Takeaways",id:"takeaways",level:2},{value:"Conclusion",id:"conclusion",level:2}];function l(e){const t={a:"a",admonition:"admonition",h2:"h2",h3:"h3",h4:"h4",img:"img",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,n.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.h2,{id:"introduction-to-opensauced-for-students",children:"Introduction to OpenSauced for Students"}),"\n",(0,i.jsx)(t.p,{children:"Welcome to the wonderful world of open source. As a student, you'll find countless opportunities to contribute to projects, collaborate across global projects, and enhance your resume through meaningful contributions. You can use OpenSauced as a tool to enhance your open source journey by helping you to find interesting repositories that match your academic and personal interests, document your journey, learn from the community, and showcase your growth."}),"\n",(0,i.jsxs)(t.p,{children:["In this guide, you will learn how to use OpenSauced features like your personal ",(0,i.jsx)(t.a,{href:"/features/dev-card",children:"Dev Card"}),", ",(0,i.jsx)(t.a,{href:"/features/highlights",children:"Highlights"}),", ",(0,i.jsx)(t.a,{href:"/features/contributor-insights",children:"Contributor Insights"}),", and ",(0,i.jsx)(t.a,{href:"/features/repo-insights",children:"Repository Insights"})," to showcase your open source work and build connections to help you meet your next goals."]}),"\n",(0,i.jsx)(t.h2,{id:"getting-started",children:"Getting Started"}),"\n",(0,i.jsxs)(t.p,{children:["To get started, you will need to create an account on OpenSauced. You can do this by visiting ",(0,i.jsx)(t.a,{href:"https://app.opensauced.pizza",children:"app.opensauced.pizza"}),' and clicking the "Connect with GitHub" button. You will be prompted to sign in with your GitHub account. Once you have signed in, you will be redirected to the OpenSauced dashboard. The best place to get started is by creating your profile.']}),"\n",(0,i.jsx)(t.h2,{id:"creating-your-profile",children:"Creating Your Profile"}),"\n",(0,i.jsx)(t.p,{children:"Creating your profile is a great way to showcase your open source contributions, connect with other contributors and maintainers, and share with your classmates, communities, and connections. Here are some steps to help you get started:"}),"\n",(0,i.jsxs)(t.ol,{children:["\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsx)(t.p,{children:'After creating your account, navigate to "Settings."'}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.img,{alt:"settings",src:o(1102).A+"",width:"746",height:"178"})}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsx)(t.p,{children:"Once there, you will be asked to add your name, bio, links to your social media accounts, timezone, and other forms of contact information."}),"\n",(0,i.jsx)(t.admonition,{type:"tip",children:(0,i.jsx)(t.p,{children:"Don't forget to add your personal site, GitHub Sponsors URL, and LinkedIn so people can connect with you and learn more about your work."})}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsx)(t.p,{children:'In the "Interests" section, select the various programming languages and topics you are interested in. Setting them up helps us recommend open source projects that fit your interests.'}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsx)(t.p,{children:"Manage your email preferences."}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(t.h3,{id:"your-profile",children:"Your Profile"}),"\n",(0,i.jsx)(t.p,{children:"Your profile is a great resource for showcasing your contributions and sharing your open source work with others."}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.img,{alt:"your profile",src:o(6726).A+"",width:"955",height:"994"})}),"\n",(0,i.jsxs)(t.p,{children:['On your profile, you will see the "Highlights" tab, which you can learn more about ',(0,i.jsx)(t.a,{href:"#highlights-connecting-and-recognizing-contributions",children:"in this section"}),". Other tabs you may find useful on your profile are:"]}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Contributions"}),": This tab includes a graph showing the number of PRs you have opened, ",(0,i.jsx)(t.a,{href:"/welcome/glossary#pr-velocity",children:"the velocity of your PRs"}),', and the number of repositories you have contributed to in the last thirty days. Underneath the graph is a "Latest PRs" chart, which shows a list of current and recent PRs. This tab is helpful if you want to showcase a steady and consistent open source contribution experience.']}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Recommendations"}),': This tab includes a list of open source projects that are chosen based on the programming languages you picked in the "Interests" section of your public profile. It is useful if you\'re looking for new projects to contribute to.']}),"\n"]}),"\n",(0,i.jsx)(t.admonition,{type:"tip",children:(0,i.jsx)(t.p,{children:"To get the full benefit of your profile, share it on social media, include a link to it on your resume, LinkedIn, your GitHub Readme, and your personal website to showcase your most up-to-date open source contributions."})}),"\n",(0,i.jsx)(t.h3,{id:"your-dev-card",children:"Your Dev Card"}),"\n",(0,i.jsxs)(t.p,{children:["Another fun way to share your open source contributions is through your ",(0,i.jsx)(t.a,{href:"/features/dev-card",children:"Dev Card"}),". Your Dev Card is a visual representation of your open source contributions. It includes your profile picture, name, bio, and the number of your latest contributions."]}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.img,{alt:"dev card",src:o(3707).A+"",width:"940",height:"658"})}),"\n",(0,i.jsx)(t.h2,{id:"explore-finding-your-next-open-source-project",children:"Explore: Finding Your Next Open Source Project"}),"\n",(0,i.jsx)(t.p,{children:'The "Explore" tab is a great place to start if you\'re looking for a new open source project to contribute to. Here, you can find a list of open source projects and filter them by language, top repos, recent, most active, and more.'}),"\n",(0,i.jsx)(t.p,{children:"Once you've selected your filters, you'll be able to see the contributors, spam, and activity levels of the repository. Understanding a repository's activity level and PR velocity can help you determine if it's a good fit for you to contribute to and what to expect when you submit a PR."}),"\n",(0,i.jsxs)(t.p,{children:['For example, if you wanted to look for a JavaScript project to contribute to, you would select "JavaScript" from the language dropdown and "Most Active" from the filter dropdown to see the most active JavaScript projects on GitHub. If you want to keep track of the repositories you\'re interested in contributing to, you can select and add them to a ',(0,i.jsx)(t.a,{href:"/features/repo-insights",children:"Repository Insights Page"})," or your ",(0,i.jsx)(t.a,{href:"/features/workspaces",children:"Workspace"}),"."]}),"\n",(0,i.jsx)(t.h2,{id:"highlights-connecting-and-recognizing-contributions",children:"Highlights: Connecting and Recognizing Contributions"}),"\n",(0,i.jsxs)(t.p,{children:["Leveraging OpenSauced's ",(0,i.jsx)(t.a,{href:"/features/highlights",children:"Highlights"})," feature is a great way to showcase your valuable contributions to open source projects. You can curate and share your achievements and milestones, bringing visibility to your hard work."]}),"\n",(0,i.jsx)(t.p,{children:"The Highlights feature allows you to:"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:"talk about issues that you raised,"}),"\n",(0,i.jsx)(t.li,{children:"share blog posts that you've written,"}),"\n",(0,i.jsx)(t.li,{children:"display Pull Requests that showcase your contributions."}),"\n"]}),"\n",(0,i.jsx)(t.h3,{id:"creating-a-new-highlight",children:"Creating a New Highlight"}),"\n",(0,i.jsx)(t.p,{children:"There are two ways to create a new highlight:"}),"\n",(0,i.jsxs)(t.ol,{children:["\n",(0,i.jsx)(t.li,{children:"Paste the URL to your PR, issue, or blog post (shown in blue below)."}),"\n",(0,i.jsx)(t.li,{children:"Choose from a list of suggestions (shown in orange below)."}),"\n"]}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.img,{alt:"highlight suggestions",src:o(7718).A+"",width:"626",height:"633"})}),"\n",(0,i.jsx)(t.admonition,{type:"note",children:(0,i.jsx)(t.p,{children:"If you're adding a blog post, you'll need to associate it to a repository by clicking the \"Add a repo\" button."})}),"\n",(0,i.jsx)(t.p,{children:"Finally, it's time to add the details of your highlight. You can write the description yourself or use the auto-summarize button to generate one."}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.img,{alt:"gif of creating a highlight",src:o(9001).A+"",width:"2294",height:"1066"})}),"\n",(0,i.jsx)(t.h3,{id:"writing-an-effective-highlight",children:"Writing an Effective Highlight"}),"\n",(0,i.jsx)(t.p,{children:"Sharing the story of your hard work is an opportunity to connect with the reader, which could include potential collaborators, other contributors, maintainers, or anyone on OpenSauced. Here are some tips to help you write effective stories for your highlights:"}),"\n",(0,i.jsx)(t.h4,{id:"highlighting-issues",children:"Highlighting Issues"}),"\n",(0,i.jsxs)(t.ol,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Share your motivation"}),': Briefly explain why you raised the issue. For example, "I\'m passionate about improving accessibility because I believe everyone should have equal access to information."']}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Summarize the issue"}),": Briefly describe the issue you wrote so your readers have context. For example, \"I raised an issue to add alt text to images in the project's 'About Us' page.\""]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Describe the impact:"}),' Briefly state how the resolution of the issue will improve the project. For example, "This will help people who use screen readers understand the content better."']}),"\n"]}),"\n",(0,i.jsx)(t.h4,{id:"highlighting-prs",children:"Highlighting PRs"}),"\n",(0,i.jsxs)(t.ol,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Describe the PR"}),': Start with a clear summary of what your PR accomplishes. For example, "I added a new feature to the project\'s Chrome Extension that allows users to summarize content."']}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Highlight your solution and its impact"}),': Briefly describe the solution, any challenges you faced, or any part of the PR you\'re particularly proud of. For example, "Initially, I faced challenges with the API, but I was able to resolve them using a different endpoint."']}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Reflect on your experience"}),': Mention what you learned from working on the PR. For example, "I learned a lot about the Chrome Extension API and how to use it to create new features."']}),"\n"]}),"\n",(0,i.jsx)(t.h4,{id:"highlighting-blog-posts",children:"Highlighting Blog Posts"}),"\n",(0,i.jsxs)(t.ol,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Describe the topic"}),": Begin with an interesting blog post summary to help others understand your writing."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Discuss the inspiration"}),": Explain why you wrote this blog post. Is it to guide others on improving their coding skills, raise awareness about an issue in the tech community, or display your progress in learning a new programming language?"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"End with a call-to-action"}),": Encourage others to read and engage with the post."]}),"\n"]}),"\n",(0,i.jsx)(t.h2,{id:"creating-your-workspace",children:"Creating Your Workspace"}),"\n",(0,i.jsx)(t.p,{children:"As a student working on multiple projects or contributing to various open source repositories, keeping track of progress, goals, and collaboration can be daunting. To keep track of the repositories that are most important to you or repositories that you're working on with a team, OpenSauced Workspaces can be your go-to tool for organizing and understanding your open source journey."}),"\n",(0,i.jsx)(t.p,{children:"Your Workspace helps you to:"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Understand projects at a high level"}),": Being able to look at all the repositories that are important to you and understand them at a high level makes it easier for you to share this information and collaborate with others."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Enhance team collaboration"}),": If you're working with a group, you can keep track of what everyone is working on. This transparency is key to teamwork and support, whether you're setting goals for a class project, contributing to a group assignment, or working together for accountability."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Deepen your project insight"}),": Understanding the underlying activities of the projects you're tracking helps you to understand their progress, health, and the community of student contributors you're part of."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Celebrate and communicate your achievements"}),": When it's time to talk about your experience, having analytics on the projects you worked on allows you to showcase your contributions, acknowledge the efforts of your peers, and clearly communicate the hard work invested."]}),"\n"]}),"\n",(0,i.jsx)(t.p,{children:"Workspaces offer a centralized platform. It's perfect for students to organize, track, and analyze the open source projects they're working on."}),"\n",(0,i.jsx)(t.h3,{id:"creating-a-new-workspace",children:"Creating a New Workspace"}),"\n",(0,i.jsxs)(t.p,{children:["To create a workspace, start by accessing the ",(0,i.jsx)(t.strong,{children:"Workspace switcher"})," in the sidebar. From there, you can create a new workspace or view an existing one."]}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.img,{alt:"workspace switcher",src:o(8164).A+"",width:"1877",height:"888"})}),"\n",(0,i.jsx)("br",{}),"\n",(0,i.jsx)(t.admonition,{type:"note",children:(0,i.jsx)(t.p,{children:'Whenever you select "Home", you\'ll be taken to the last workspace you opened.'})}),"\n",(0,i.jsx)(t.h3,{id:"adding-repositories-to-your-workspace",children:"Adding Repositories to Your Workspace"}),"\n",(0,i.jsx)(t.p,{children:"If you're creating a new workspace, you'll have the option to add repositories at the time of creation."}),"\n",(0,i.jsx)(t.p,{children:'Start by creating a workspace name, then click "Add repositories". You\'ll have three options for adding repositories:'}),"\n",(0,i.jsxs)(t.ol,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Search for Repositories"}),": Use our search tool by adding an organization name, followed by the repository name, and add them to your workspace."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Import a GitHub Organization"}),": Connect to your GitHub organizations to create a workspace from an organization. (If you're having trouble with this, see the \"",(0,i.jsx)(t.a,{href:"/welcome/faqs#sync-your-github-team",children:"Sync Your GitHub Team"}),'" section in our FAQs.)']}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Import Repositories"}),": Paste a list of repositories to add to your workspace."]}),"\n"]}),"\n",(0,i.jsx)(t.p,{children:"Once your repositories are added, you'll be able to see them in your repository dashboard. You can also edit your workspace to add or remove repositories anytime."}),"\n",(0,i.jsx)(t.h3,{id:"navigating-your-workspace",children:"Navigating Your Workspace"}),"\n",(0,i.jsx)(t.p,{children:"Once your repositories are connected, you'll enter your Workspace dashboard. In your workspace dashboards, you can create, view, and manage your workspaces."}),"\n",(0,i.jsx)(t.h4,{id:"repositories-dashboard",children:"Repositories Dashboard"}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.img,{alt:"Workspaces",src:o(389).A+"",width:"3200",height:"1800"})}),"\n",(0,i.jsx)(t.p,{children:"Within the repositories dashboard, you can view the following metrics, which are over a period of thirty days by default:"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Pull Requests"}),": This includes the total number of opened and merged pull requests for the repositories in your workspace and the velocity of pull requests being merged."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Issues"}),": This includes the total number of opened and closed issues for the repositories in your workspace and the velocity of issues being closed."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Engagement"}),": This includes the total number of stars, forks, and activity ratio for the repositories in your workspace."]}),"\n"]}),"\n",(0,i.jsx)(t.h3,{id:"why-create-a-workspace",children:"Why Create a Workspace?"}),"\n",(0,i.jsx)(t.p,{children:"There are many reasons to create a workspace. Here are a few:"}),"\n",(0,i.jsxs)(t.ol,{children:["\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"Targeted Contributions"}),": Workspaces allow you to create a list of repositories you are interested in or actively contributing to, which can help you stay focused on projects that align with your interests or goals."]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"Job Search Organization"}),": You can create workspaces dedicated to tracking open source projects from companies known for hiring contributors, which can help you find potential job opportunities."]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"Coursework Management"}),": For managing group open source projects or individual assignments, a workspace can be used to organize repositories that are part of the assignments, keeping all relevant repositories in one accessible location."]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"Skill-Specific Exploration"}),": You can use workspaces to follow repositories that help you build specific skills or understand certain technologies, creating a tailored learning environment that aligns with your career path or focus."]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"Community Engagement Tracking"}),": By adding repositories you're interested in, you can monitor and engage with the communities behind them. This allows you to understand the dynamics of open source collaboration, which is invaluable for both personal and professional networking."]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(t.h2,{id:"repository-insights-connecting-your-repositories",children:"Repository Insights: Connecting Your Repositories"}),"\n",(0,i.jsxs)(t.p,{children:["OpenSauced ",(0,i.jsx)(t.a,{href:"/features/repo-insights",children:"Repository Insights"})," allows you to track open source projects you are interested in. You can use Repository Insights Pages to track repositories' growth, analyze work, and connect with others."]}),"\n",(0,i.jsx)(t.h3,{id:"why-create-a-repository-insights-page",children:"Why Create a Repository Insights Page?"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"To track projects you're working on"}),": Tracking projects you're working on can help you stay up-to-date with the latest activity and trends and connect with other contributors."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"To identify potential projects to contribute to"}),': If you\'re looking for a new project to contribute to, you can use the Repository Insights feature to track active projects that are looking for contributors. You can use the "Explore" tab to find new projects to contribute to and track them with your Repository Insights page.']}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"To network and engage with the community"}),': Finding people to work and connect with can be challenging. You can connect with your network through the feature\'s "Contributors" tab.']}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"To track the activity of a topic you're interested in"}),": Keeping up with the latest trends and activity in a particular topic can be challenging. You can use the Repository Insights feature to track the activity of a specific topic and find new projects to contribute to. For example, you can create a ",(0,i.jsx)(t.a,{href:"https://app.opensauced.pizza/pages/BekahHW/1055/dashboard",children:"Repository Insight Page for Active AI Repositories"}),"."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"To track the activity of your favorite programming languages"}),": If you're interested in tracking the activity of your favorite programming languages, you can use the Repository Insights feature to track the open source projects that are using them."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"To aid in the job search"}),": If you're looking for a job, you can use the Repository Insights feature to track the activity of the organizations you're interested in working on. This can help you understand the activity level of the repositories and the types of contributions being made, and even identify which company you want to contribute to."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Curating collections for interest groups"}),": You can curate and share repositories focusing on sectors and programming languages that interest you."]}),"\n"]}),"\n",(0,i.jsx)(t.p,{children:"Within your workspace, you can create new lists of repositories called Repository Insight Pages."}),"\n",(0,i.jsx)(t.h3,{id:"creating-a-new-repository-insight-page",children:"Creating a New Repository Insight Page"}),"\n",(0,i.jsx)(t.p,{children:'To track the repositories, click the "+" next to "Insights" in the sidebar, then select "New Repository Insight." You will be redirected to a page where you can create your new Repository Insight Page.'}),"\n",(0,i.jsx)(t.p,{children:"There are two ways to add repositories to your Repository Insight Page:"}),"\n",(0,i.jsxs)(t.ol,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Sync GitHub organization"}),": Syncing your GitHub organizations is a good idea if you want to keep track of their open source project activities and trends."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Connect individual repositories"}),": Connecting individual repositories is a good idea if you want to keep track of the contributions of a specific repository or group of repositories."]}),"\n"]}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.img,{alt:"sync Repository Insights gif",src:o(709).A+"",width:"960",height:"543"})}),"\n",(0,i.jsx)(t.h3,{id:"using-your-repository-insights-page",children:"Using Your Repository Insights Page"}),"\n",(0,i.jsx)(t.p,{children:"Once you have connected your repositories, you will be redirected to your Repository Insight Page. Here, you will see a dashboard with an overview of the repositories and the contributors who have contributed to them."}),"\n",(0,i.jsx)(t.p,{children:"There are three tabs that provide you with more information on these repositories:"}),"\n",(0,i.jsx)(t.h4,{id:"repositories-dashboard-1",children:"Repositories Dashboard"}),"\n",(0,i.jsx)(t.p,{children:"If you're looking for an active project to contribute to, this tab can help you. It contains information such as activity levels, PR overview, PR velocity, spam PRs, contributors, and activity stats over the last 30 days. This information is also a good way to connect with others on the project or where to find support."}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.img,{alt:"repositories tab",src:o(4394).A+"",width:"1148",height:"796"})}),"\n",(0,i.jsx)(t.h4,{id:"contributors",children:"Contributors"}),"\n",(0,i.jsx)(t.p,{children:'The "Contributors" tab allows you to view more detailed information about other contributors, including activity levels, the number of repositories they contributed to, the date of their last contribution, their most used language, their time zone, the number of contributions, and their activity stats over the last 30 days. This can be a great way to find others to collaborate with or to reach out to for support.'}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.img,{alt:"contributors insight list",src:o(9333).A+"",width:"1212",height:"628"})}),"\n",(0,i.jsx)(t.admonition,{type:"tip",children:(0,i.jsx)(t.p,{children:"Want to learn more about your peers? You can select and add them to a Contributor Insight Page."})}),"\n",(0,i.jsx)(t.h4,{id:"activity",children:"Activity"}),"\n",(0,i.jsx)(t.p,{children:"The \"Activity\" tab shows a graph of the last time each contributor created their PR and how many lines of code they've touched. It also provides more detailed information on each contributor when you hover over their image, including their latest PRs and repositories they've contributed to. Clicking their image will bring you to their profile on OpenSauced."}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.img,{alt:"activity graph",src:o(3046).A+"",width:"1592",height:"791"})}),"\n",(0,i.jsx)(t.p,{children:"Beyond understanding repositories, you may want to get insights into other contributors to help you learn more about how others are contributing to open source. One way to do that is through Contributor Insights."}),"\n",(0,i.jsx)(t.h2,{id:"contributor-insights-connecting-with-contributors",children:"Contributor Insights: Connecting with Contributors"}),"\n",(0,i.jsxs)(t.p,{children:["The ",(0,i.jsx)(t.a,{href:"/features/contributor-insights",children:"Contributor Insights"})," feature helps you connect with other contributors or learn more about what others are up to in open source. With this feature, you can categorize, watch, and check out different groups of contributors within open source projects."]}),"\n",(0,i.jsx)(t.h3,{id:"what-can-you-do-with-contributor-insights",children:"What Can You Do with Contributor Insights?"}),"\n",(0,i.jsx)(t.p,{children:"There are many things you can do with this feature, but here are some ideas to get you started:"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Track personal contributions"}),": If you create a list of your personal contributions, you can track them and see how you're doing over time, as well as get a breakdown of the type of contributions you're making, including commits, created PRs, reviewed PRs, and created issues."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Learn about what other contributors are doing in open source"}),": You can learn where other contributors are contributing, what they're working on, and how active they are in the open source community."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"See who's using the OpenSauced Highlights feature"}),": You can see who's using the Highlights feature and show them support by giving an emoji reaction."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Track contributors for job opportunities"}),": If you're looking for a job, you can track the activity of the contributors you're interested in working with. This helps you understand the activity level of the repositories and the types of contributions being made, and you can even identify which company you want to contribute to."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Track your classmates or peers"}),": If you're working with a group, you can track the activity of your classmates or peers to see what they're working on and how active they are in the open source community."]}),"\n"]}),"\n",(0,i.jsx)(t.h3,{id:"creating-a-new-contributor-insights-page",children:"Creating a New Contributor Insights Page"}),"\n",(0,i.jsxs)(t.ol,{children:["\n",(0,i.jsx)(t.li,{children:'Click the "+" next to "Insights" in your sidebar.'}),"\n",(0,i.jsx)(t.li,{children:'Select "New Contributor Insight" to start a new Contributor Insight Page.'}),"\n",(0,i.jsx)(t.li,{children:"Give your page a name."}),"\n",(0,i.jsx)(t.li,{children:"Add contributors to your page by searching for their GitHub username, syncing your GitHub Team, or importing your GitHub Following."}),"\n",(0,i.jsx)(t.li,{children:"Once your page is created, you can edit and choose to make it public or private. By default, it is set to public. To create a private page, you can upgrade your account to a paid plan."}),"\n"]}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.img,{alt:"contribution sync gif",src:o(8896).A+"",width:"1324",height:"1030"})}),"\n",(0,i.jsx)(t.h2,{id:"using-your-contributor-insights-page",children:"Using Your Contributor Insights Page"}),"\n",(0,i.jsx)(t.p,{children:"Once you have created your list, you will be redirected to your Contributor Insights Page. Here, you will see a dashboard with an overview of the contributors."}),"\n",(0,i.jsx)(t.p,{children:"There are three tabs that provide you with more information on these repositories:"}),"\n",(0,i.jsx)(t.h3,{id:"overview",children:"Overview"}),"\n",(0,i.jsx)(t.p,{children:'The "Overview" tab gives you a high-level view of the contributors in your list, including the total number of commits in the last 30 days and the types of contributors: Active, New, and Alumni.'}),"\n",(0,i.jsx)(t.h3,{id:"activity-1",children:"Activity"}),"\n",(0,i.jsx)(t.p,{children:'The "Activity" tab gives you a graph view with more detailed information on each contributor, including the type of activity, repositories they\'ve contributed to, and how they compare to each other.'}),"\n",(0,i.jsx)(t.p,{children:"You can filter your Contributor Insight Page by All Contributors, Active Contributors, New Contributors, and Alumni Contributors."}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.img,{alt:"list graph",src:o(9834).A+"",width:"1263",height:"781"})}),"\n",(0,i.jsx)(t.h3,{id:"highlights",children:"Highlights"}),"\n",(0,i.jsx)(t.p,{children:'The "Highlights" tab gives you a list of the highlights that the contributors listed on your page have created. This is a great way to see what other contributors are up to and to show them support.'}),"\n",(0,i.jsx)(t.h2,{id:"takeaways",children:"Takeaways"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Create Your Profile"}),": Creating your profile is a great way to display your open source contributions, connect with other contributors and maintainers, and share during a job search."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Explore"}),': The "Explore" tab is a great place to find new open source projects to contribute to.']}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Highlights"}),": Leveraging OpenSauced's Highlights feature is a great way for you to showcase your valuable contributions to open source projects."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Repository Insights"}),": OpenSauced Repository Insights feature allows you to track open source projects you are interested in."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Contributor Insights"}),": The Contributor Insights feature helps you understand other contributors or track your own work in open source."]}),"\n"]}),"\n",(0,i.jsx)(t.h2,{id:"conclusion",children:"Conclusion"}),"\n",(0,i.jsx)(t.p,{children:"Embarking on your open source journey with OpenSauced opens up a world of learning and development opportunities. It's a chance to apply your knowledge to real-world projects, collaborate with a global community, and build a portfolio that stands out to educators and employers alike. We're excited to support you on this journey and can't wait to see the contributions you'll make and the milestones you'll achieve. If you have any questions or need assistance, our community is here to help you navigate your path in open source."}),"\n",(0,i.jsx)(t.p,{children:"Here are some other resources you might find helpful in your journey:"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.a,{href:"/community/100-days-of-oss",children:"100 Days of OSS"})}),"\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.a,{href:"https://intro.opensauced.pizza/#/",children:"Intro to Open Source Course"})}),"\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.a,{href:"https://opensauced.pizza/blog/resume-driven-contributions",children:"Resume Driven Contributions"})}),"\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.a,{href:"https://opensauced.pizza/blog/stop-burning-out-maintainers-an-empathetic-guide-for-contributors",children:"Stop Burning Out Maintainers: An Empathetic Guide for Contributors"})}),"\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.a,{href:"https://gh.io/AApppma",children:"GitHub Student Benefits"})}),"\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.a,{href:"https://gh.io/AApphwi",children:"GitHub Student Developer Pack"})}),"\n"]})]})}function u(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},8896:(e,t,o)=>{o.d(t,{A:()=>i});const i=o.p+"assets/images/contributors-sync-list-b427c1971ecbd190a472a1a061bf63a6.gif"},9001:(e,t,o)=>{o.d(t,{A:()=>i});const i=o.p+"assets/images/highlight-e3a2da2446fe91467a31d225755bf40a.gif"},709:(e,t,o)=>{o.d(t,{A:()=>i});const i=o.p+"assets/images/insight-page-demo-cc2291df69361b2d476ccffcdbd1ee25.gif"},3707:(e,t,o)=>{o.d(t,{A:()=>i});const i=o.p+"assets/images/a-dev-card-f7b01f48467c20d93ddb9814e8e54918.png"},3046:(e,t,o)=>{o.d(t,{A:()=>i});const i=o.p+"assets/images/activity-repos-insights-3734baf3ab38356a4de96d43dde41a3d.png"},9333:(e,t,o)=>{o.d(t,{A:()=>i});const i=o.p+"assets/images/contributors-insights-1bc09dd6a32c3a16eba8b63ec351157f.png"},7718:(e,t,o)=>{o.d(t,{A:()=>i});const i=o.p+"assets/images/highlights-fcc750f036bb2ea7c11166c8338d7f6c.png"},9834:(e,t,o)=>{o.d(t,{A:()=>i});const i=o.p+"assets/images/list-graph-e2718b080f8d3af7e28011a6f064f46e.png"},6726:(e,t,o)=>{o.d(t,{A:()=>i});const i=o.p+"assets/images/profile-d4fae85bbb516b6a5b5837a3d137c223.png"},4394:(e,t,o)=>{o.d(t,{A:()=>i});const i=o.p+"assets/images/repos-insights-2db5d8c668cee2f528f47ae986d664c7.png"},1102:(e,t,o)=>{o.d(t,{A:()=>i});const i=o.p+"assets/images/settings-748558f026c2a0b1c23cbb3648bf3a05.png"},8164:(e,t,o)=>{o.d(t,{A:()=>i});const i=o.p+"assets/images/workspace-switcher-b2400ec5c309a762f822268b44779930.png"},389:(e,t,o)=>{o.d(t,{A:()=>i});const i=o.p+"assets/images/workspace-644e59bed496d2a0df7502aaa833129e.png"},8453:(e,t,o)=>{o.d(t,{R:()=>s,x:()=>a});var i=o(6540);const n={},r=i.createContext(n);function s(e){const t=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:s(e.components),i.createElement(r.Provider,{value:t},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/914479fa.bad0370b.js b/assets/js/914479fa.bad0370b.js
deleted file mode 100644
index c91cd994..00000000
--- a/assets/js/914479fa.bad0370b.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunk_open_sauced_docs_opensauced_pizza=self.webpackChunk_open_sauced_docs_opensauced_pizza||[]).push([[6894],{4182:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>s,default:()=>g,frontMatter:()=>a,metadata:()=>r,toc:()=>d});var o=n(4848),i=n(8453);const a={id:"refactoring-and-testing",title:"Refactoring and Testing",sidebar_label:"Refactoring and Testing",keywords:["refactoring","testing","refactoring and testing best practices","how to refactor and test code","benefits of refactoring and testing","refactoring and testing tools","refactoring and testing techniques","refactoring and testing examples","refactoring and testing tutorial"]},s=void 0,r={id:"tools/chrome-extension/refactoring-and-testing",title:"Refactoring and Testing",description:"Refactoring a Block of Code",source:"@site/docs/tools/chrome-extension/refactoring-and-testing.md",sourceDirName:"tools/chrome-extension",slug:"/tools/chrome-extension/refactoring-and-testing",permalink:"/tools/chrome-extension/refactoring-and-testing",draft:!1,unlisted:!1,editUrl:"https://github.com/open-sauced/docs.opensauced.pizza/edit/main/docs/tools/chrome-extension/refactoring-and-testing.md",tags:[],version:"current",lastUpdatedBy:"BekahHW",lastUpdatedAt:171701191e4,frontMatter:{id:"refactoring-and-testing",title:"Refactoring and Testing",sidebar_label:"Refactoring and Testing",keywords:["refactoring","testing","refactoring and testing best practices","how to refactor and test code","benefits of refactoring and testing","refactoring and testing tools","refactoring and testing techniques","refactoring and testing examples","refactoring and testing tutorial"]},sidebar:"docs",previous:{title:"Highlight",permalink:"/tools/chrome-extension/highlights"},next:{title:"Insights and Invitations",permalink:"/tools/chrome-extension/viewing-insights-and-invitations"}},c={},d=[{value:"Refactoring a Block of Code",id:"refactoring-a-block-of-code",level:2},{value:"Testing a Block of Code",id:"testing-a-block-of-code",level:2}];function l(e){const t={h2:"h2",img:"img",p:"p",...(0,i.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(t.h2,{id:"refactoring-a-block-of-code",children:"Refactoring a Block of Code"}),"\n",(0,o.jsx)(t.p,{children:"Refactor a block of code by using the blue plus button that is displayed when hovering over a line. To select a block of code, hover over the starting line, click, and drag the blue plus button until you reach the desired line."}),"\n",(0,o.jsx)(t.p,{children:(0,o.jsx)(t.img,{alt:"generate code refactor",src:n(9956).A+"",width:"828",height:"481"})}),"\n",(0,o.jsx)(t.h2,{id:"testing-a-block-of-code",children:"Testing a Block of Code"}),"\n",(0,o.jsx)(t.p,{children:"Generate tests for a block of code by using the blue plus button that is displayed when hovering over a line. To select a block of code, hover over the starting line, click, and drag the blue plus button until you reach the desired line."}),"\n",(0,o.jsx)(t.p,{children:(0,o.jsx)(t.img,{alt:"generate code refactor",src:n(2862).A+"",width:"828",height:"481"})})]})}function g(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},9956:(e,t,n)=>{n.d(t,{A:()=>o});const o=n.p+"assets/images/pr-code-refactor-2b26ff383ff3a6351a5b4feda98abafd.gif"},2862:(e,t,n)=>{n.d(t,{A:()=>o});const o=n.p+"assets/images/pr-code-test-90211422d3a31f62a0d0c8e073d7454a.gif"},8453:(e,t,n)=>{n.d(t,{R:()=>s,x:()=>r});var o=n(6540);const i={},a=o.createContext(i);function s(e){const t=o.useContext(a);return o.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function r(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),o.createElement(a.Provider,{value:t},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/914479fa.c71ff06a.js b/assets/js/914479fa.c71ff06a.js
new file mode 100644
index 00000000..558e9680
--- /dev/null
+++ b/assets/js/914479fa.c71ff06a.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunk_open_sauced_docs_opensauced_pizza=self.webpackChunk_open_sauced_docs_opensauced_pizza||[]).push([[6894],{4182:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>s,default:()=>g,frontMatter:()=>a,metadata:()=>r,toc:()=>d});var o=n(4848),i=n(8453);const a={id:"refactoring-and-testing",title:"Refactoring and Testing",sidebar_label:"Refactoring and Testing",keywords:["refactoring","testing","refactoring and testing best practices","how to refactor and test code","benefits of refactoring and testing","refactoring and testing tools","refactoring and testing techniques","refactoring and testing examples","refactoring and testing tutorial"]},s=void 0,r={id:"tools/chrome-extension/refactoring-and-testing",title:"Refactoring and Testing",description:"Refactoring a Block of Code",source:"@site/docs/tools/chrome-extension/refactoring-and-testing.md",sourceDirName:"tools/chrome-extension",slug:"/tools/chrome-extension/refactoring-and-testing",permalink:"/tools/chrome-extension/refactoring-and-testing",draft:!1,unlisted:!1,editUrl:"https://github.com/open-sauced/docs.opensauced.pizza/edit/main/docs/tools/chrome-extension/refactoring-and-testing.md",tags:[],version:"current",lastUpdatedBy:"BekahHW",lastUpdatedAt:1717170876e3,frontMatter:{id:"refactoring-and-testing",title:"Refactoring and Testing",sidebar_label:"Refactoring and Testing",keywords:["refactoring","testing","refactoring and testing best practices","how to refactor and test code","benefits of refactoring and testing","refactoring and testing tools","refactoring and testing techniques","refactoring and testing examples","refactoring and testing tutorial"]},sidebar:"docs",previous:{title:"Highlight",permalink:"/tools/chrome-extension/highlights"},next:{title:"Insights and Invitations",permalink:"/tools/chrome-extension/viewing-insights-and-invitations"}},c={},d=[{value:"Refactoring a Block of Code",id:"refactoring-a-block-of-code",level:2},{value:"Testing a Block of Code",id:"testing-a-block-of-code",level:2}];function l(e){const t={h2:"h2",img:"img",p:"p",...(0,i.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(t.h2,{id:"refactoring-a-block-of-code",children:"Refactoring a Block of Code"}),"\n",(0,o.jsx)(t.p,{children:"Refactor a block of code by using the blue plus button that is displayed when hovering over a line. To select a block of code, hover over the starting line, click, and drag the blue plus button until you reach the desired line."}),"\n",(0,o.jsx)(t.p,{children:(0,o.jsx)(t.img,{alt:"generate code refactor",src:n(9956).A+"",width:"828",height:"481"})}),"\n",(0,o.jsx)(t.h2,{id:"testing-a-block-of-code",children:"Testing a Block of Code"}),"\n",(0,o.jsx)(t.p,{children:"Generate tests for a block of code by using the blue plus button that is displayed when hovering over a line. To select a block of code, hover over the starting line, click, and drag the blue plus button until you reach the desired line."}),"\n",(0,o.jsx)(t.p,{children:(0,o.jsx)(t.img,{alt:"generate code refactor",src:n(2862).A+"",width:"828",height:"481"})})]})}function g(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},9956:(e,t,n)=>{n.d(t,{A:()=>o});const o=n.p+"assets/images/pr-code-refactor-2b26ff383ff3a6351a5b4feda98abafd.gif"},2862:(e,t,n)=>{n.d(t,{A:()=>o});const o=n.p+"assets/images/pr-code-test-90211422d3a31f62a0d0c8e073d7454a.gif"},8453:(e,t,n)=>{n.d(t,{R:()=>s,x:()=>r});var o=n(6540);const i={},a=o.createContext(i);function s(e){const t=o.useContext(a);return o.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function r(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),o.createElement(a.Provider,{value:t},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/9b3a7c99.7a63ae62.js b/assets/js/9b3a7c99.7a63ae62.js
deleted file mode 100644
index 6b5b5d8d..00000000
--- a/assets/js/9b3a7c99.7a63ae62.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunk_open_sauced_docs_opensauced_pizza=self.webpackChunk_open_sauced_docs_opensauced_pizza||[]).push([[6738],{7150:(e,t,i)=>{i.r(t),i.d(t,{assets:()=>c,contentTitle:()=>s,default:()=>u,frontMatter:()=>r,metadata:()=>a,toc:()=>h});var o=i(4848),n=i(8453);const r={id:"contributors-guide-to-open-sauced",title:"Contributors Guide to OpenSauced",sidebar_label:"Contributors Guide to OpenSauced",keywords:["contributors","guides"]},s=void 0,a={id:"contributors/contributors-guide-to-open-sauced",title:"Contributors Guide to OpenSauced",description:"Introduction to OpenSauced for Contributors",source:"@site/docs/contributors/contributors-guide.md",sourceDirName:"contributors",slug:"/contributors/contributors-guide-to-open-sauced",permalink:"/contributors/contributors-guide-to-open-sauced",draft:!1,unlisted:!1,editUrl:"https://github.com/open-sauced/docs.opensauced.pizza/edit/main/docs/contributors/contributors-guide.md",tags:[],version:"current",lastUpdatedBy:"BekahHW",lastUpdatedAt:171701191e4,frontMatter:{id:"contributors-guide-to-open-sauced",title:"Contributors Guide to OpenSauced",sidebar_label:"Contributors Guide to OpenSauced",keywords:["contributors","guides"]},sidebar:"docs",previous:{title:"Understanding Contributor Insights Data",permalink:"/maintainers/understanding-contribs-insights"},next:{title:"Welcome to the Community",permalink:"/community/welcome-to-the-community"}},c={},h=[{value:"Introduction to OpenSauced for Contributors",id:"introduction-to-opensauced-for-contributors",level:2},{value:"Getting Started",id:"getting-started",level:2},{value:"Creating Your Profile",id:"creating-your-profile",level:2},{value:"Your Profile",id:"your-profile",level:3},{value:"Explore: Finding Your Next Open Source Project",id:"explore-finding-your-next-open-source-project",level:2},{value:"Highlights: Connecting and Recognizing Contributions",id:"highlights-connecting-and-recognizing-contributions",level:2},{value:"Creating a New Highlight",id:"creating-a-new-highlight",level:3},{value:"Writing an Effective Highlight",id:"writing-an-effective-highlight",level:3},{value:"Highlighting Issues",id:"highlighting-issues",level:4},{value:"Highlighting PRs",id:"highlighting-prs",level:4},{value:"Highlighting Blog Posts",id:"highlighting-blog-posts",level:4},{value:"Repository Insights: Connecting Your Repositories",id:"repository-insights-connecting-your-repositories",level:2},{value:"Why Create a Repository Insights Page",id:"why-create-a-repository-insights-page",level:3},{value:"Creating a New Repository Insight Page",id:"creating-a-new-repository-insight-page",level:3},{value:"Using Your Repository Insights Page",id:"using-your-repository-insights-page",level:3},{value:"Repositories Dashboard",id:"repositories-dashboard",level:4},{value:"Contributors",id:"contributors",level:4},{value:"Activity",id:"activity",level:4},{value:"Contributor Insights: Connecting with Contributors",id:"contributor-insights-connecting-with-contributors",level:2},{value:"What You can do with Contributor Insights?",id:"what-you-can-do-with-contributor-insights",level:3},{value:"Creating a New Contributor Insights Page",id:"creating-a-new-contributor-insights-page",level:3},{value:"Using Your Contributor Insights Page",id:"using-your-contributor-insights-page",level:2},{value:"Overview",id:"overview",level:3},{value:"Activity",id:"activity-1",level:3},{value:"Highlights",id:"highlights",level:3},{value:"Takeaways",id:"takeaways",level:2},{value:"Conclusion",id:"conclusion",level:2}];function l(e){const t={a:"a",admonition:"admonition",h2:"h2",h3:"h3",h4:"h4",img:"img",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,n.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(t.h2,{id:"introduction-to-opensauced-for-contributors",children:"Introduction to OpenSauced for Contributors"}),"\n",(0,o.jsx)(t.p,{children:"OpenSauced is a platform dedicated to empowering you, the contributor, in your open source journey. With OpenSauced, you can find repositories to contribute to, track your contributions, gain insights into your favorite open source projects, and find new contributors to connect with."}),"\n",(0,o.jsx)(t.h2,{id:"getting-started",children:"Getting Started"}),"\n",(0,o.jsxs)(t.p,{children:["To get started, you will need to create an account on OpenSauced. You can do this by visiting the ",(0,o.jsx)(t.a,{href:"https://app.opensauced.pizza",children:"app.opensauced.pizza"}),' and clicking the "Connect with GitHub" button. You will be prompted to sign in with your GitHub account. Once you have signed in, you will be redirected to the OpenSauced dashboard. The best place to get started is by creating your profile.']}),"\n",(0,o.jsx)(t.h2,{id:"creating-your-profile",children:"Creating Your Profile"}),"\n",(0,o.jsx)(t.p,{children:"Creating your profile is a great way to showcase your open source contributions, connect with other contributors and maintainers, and share during a job search. Here are some steps to help you get started:"}),"\n",(0,o.jsxs)(t.ol,{children:["\n",(0,o.jsxs)(t.li,{children:["\n",(0,o.jsx)(t.p,{children:'After creating your account, navigate to "Settings."'}),"\n",(0,o.jsx)(t.p,{children:(0,o.jsx)(t.img,{alt:"settings",src:i(1102).A+"",width:"746",height:"178"})}),"\n"]}),"\n",(0,o.jsxs)(t.li,{children:["\n",(0,o.jsx)(t.p,{children:"Once there, you will be asked to add your name, bio, links to your social media accounts, timezone, and other forms of contact information."}),"\n",(0,o.jsx)(t.admonition,{type:"tip",children:(0,o.jsx)(t.p,{children:"Don't forget to add your personal site, GitHub Sponsors URL, and LinkedIn so people can connect with you and learn more about your work."})}),"\n"]}),"\n",(0,o.jsxs)(t.li,{children:["\n",(0,o.jsx)(t.p,{children:'In the "Interests" section, select the various programming languages and topics you are interested in. Setting them helps us recommend open source projects that fit your interests.'}),"\n"]}),"\n",(0,o.jsxs)(t.li,{children:["\n",(0,o.jsx)(t.p,{children:"Manage your email preferences."}),"\n"]}),"\n"]}),"\n",(0,o.jsx)(t.h3,{id:"your-profile",children:"Your Profile"}),"\n",(0,o.jsx)(t.p,{children:"Your profile is a great resource for showcasing your contributions and sharing your open source work with others."}),"\n",(0,o.jsx)(t.p,{children:(0,o.jsx)(t.img,{alt:"your profile",src:i(6726).A+"",width:"955",height:"994"})}),"\n",(0,o.jsxs)(t.p,{children:['On your profile, you will see the "Highlights" tab, which you can learn more about ',(0,o.jsx)(t.a,{href:"#highlights-connecting-and-recognizing-contributions",children:"in this section"}),", and three other tabs:"]}),"\n",(0,o.jsxs)(t.ul,{children:["\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.strong,{children:"Contributions"}),": This tab includes a graph showing the number of PRs you have opened, ",(0,o.jsx)(t.a,{href:"/welcome/glossary#pr-velocity",children:"the velocity of your PRs"}),', and the number of repositories you have contributed to. Underneath the graph is a "Latest PRs" chart, which shows a list of current and recent PRs. This tab is helpful if you want to showcase a steady and consistent open source contribution experience.']}),"\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.strong,{children:"Connections"}),": For pro accounts, you can reach out to other contributors and maintainers to collaborate on projects or to learn from them."]}),"\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.strong,{children:"Recommendations"}),': This tab includes a list of open source projects that are chosen based on the programming languages you picked in the "Interests" section of your public profile. It is useful if you\'re looking for new projects to contribute to.']}),"\n"]}),"\n",(0,o.jsx)(t.h2,{id:"explore-finding-your-next-open-source-project",children:"Explore: Finding Your Next Open Source Project"}),"\n",(0,o.jsx)(t.p,{children:'The "Explore" tab is a great place to start if you\'re looking for a new open source project to contribute to or want to find repositories for potential job opportunities. Here, you can find a list of open source projects and filter them by language, top repos, recent, most active, and more.'}),"\n",(0,o.jsx)(t.p,{children:"Once you've selected your filters, you'll be able to see the contributors, spam, and activity levels of the repository. Understanding a repository's activity level and PR velocity can help you determine if it's a good fit for you to contribute to and what to expect when you submit a PR."}),"\n",(0,o.jsxs)(t.p,{children:['For example, if you wanted to look for a JavaScript project to contribute to, you would select "JavaScript" from the language dropdown and "Most Active" from the filter dropdown to see the most active JavaScript projects on GitHub. If you want to keep track of the repositories you\'re interested in contributing to, you can select and add them to your ',(0,o.jsx)(t.a,{href:"/features/repo-insights",children:"Repository Insights Page"}),"."]}),"\n",(0,o.jsx)(t.h2,{id:"highlights-connecting-and-recognizing-contributions",children:"Highlights: Connecting and Recognizing Contributions"}),"\n",(0,o.jsxs)(t.p,{children:["Leveraging OpenSauced's ",(0,o.jsx)(t.a,{href:"/features/highlights",children:"Highlights"})," feature is a great way for you to showcase your valuable contributions to open source projects. You can curate and share your achievements and milestones and bring visibility to your hard work."]}),"\n",(0,o.jsx)(t.p,{children:"The Highlights feature allows you to:"}),"\n",(0,o.jsxs)(t.ul,{children:["\n",(0,o.jsx)(t.li,{children:"talk about issues that you raised,"}),"\n",(0,o.jsx)(t.li,{children:"share blog posts that you've written,"}),"\n",(0,o.jsx)(t.li,{children:"display PRs that showcase your contributions."}),"\n"]}),"\n",(0,o.jsx)(t.h3,{id:"creating-a-new-highlight",children:"Creating a New Highlight"}),"\n",(0,o.jsx)(t.p,{children:"There are two ways to create a new highlight:"}),"\n",(0,o.jsxs)(t.ol,{children:["\n",(0,o.jsx)(t.li,{children:"Paste the URL to your PR, issue, or blog post (shown in blue below)."}),"\n",(0,o.jsx)(t.li,{children:"Choose from a list of suggestions (shown in orange below)."}),"\n"]}),"\n",(0,o.jsx)(t.p,{children:(0,o.jsx)(t.img,{alt:"highlight suggestions",src:i(7718).A+"",width:"626",height:"633"})}),"\n",(0,o.jsx)(t.admonition,{type:"note",children:(0,o.jsx)(t.p,{children:"If you're adding a blog post, you'll need to associate it to a repository by clicking the \"Add a repo\" button."})}),"\n",(0,o.jsx)(t.p,{children:"Finally, it's time to add the details of your highlight. You can write the description yourself or use the auto-summarize button to generate one."}),"\n",(0,o.jsx)(t.p,{children:(0,o.jsx)(t.img,{alt:"gif of creating a highlight",src:i(9001).A+"",width:"2294",height:"1066"})}),"\n",(0,o.jsx)(t.h3,{id:"writing-an-effective-highlight",children:"Writing an Effective Highlight"}),"\n",(0,o.jsx)(t.p,{children:"Sharing the story of your hard work is an opportunity to connect with the reader, which could include potential collaborators or recruiters. Here are some tips to help you write effective stories for your highlights:"}),"\n",(0,o.jsx)(t.h4,{id:"highlighting-issues",children:"Highlighting Issues"}),"\n",(0,o.jsxs)(t.ol,{children:["\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.strong,{children:"Share your motivation"}),': Briefly explain why you raised the issue. For example, "I\'m passionate about improving accessibility because I believe everyone should have equal access to information."']}),"\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.strong,{children:"Summarize the issue"}),": Briefly describe the issue you wrote so your readers have context. For example, \"I raised an issue to add alt text to images in the project's 'About Us' page.\""]}),"\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.strong,{children:"Describe the impact:"}),' Briefly state how the resolution of the issue will improve the project. For example, "This will help people who use screen readers to understand the content of the images."']}),"\n"]}),"\n",(0,o.jsx)(t.h4,{id:"highlighting-prs",children:"Highlighting PRs"}),"\n",(0,o.jsxs)(t.ol,{children:["\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.strong,{children:"Describe the PR"}),': Start with a clear summary of what your PR accomplishes. For example, "I added a new feature to the project\'s Chrome Extension that allows users to summarize content."']}),"\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.strong,{children:"Highlight your solution and its impact"}),': Briefly describe the solution, any challenges you faced, or any part of the PR you\'re particularly proud of. For example, "Initially, I faced challenges with the API, but I was able to resolve them using a different endpoint."']}),"\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.strong,{children:"Reflect on your experience"}),': Mention what you learned from working on the PR. For example, "I learned a lot about the Chrome Extension API and how to use it to create new features."']}),"\n"]}),"\n",(0,o.jsx)(t.h4,{id:"highlighting-blog-posts",children:"Highlighting Blog Posts"}),"\n",(0,o.jsxs)(t.ol,{children:["\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.strong,{children:"Describe the topic"}),": Begin with an interesting blog post summary to help your peers and potential recruiters understand your writing."]}),"\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.strong,{children:"Discuss the inspiration"}),": Explain why you wrote this blog post. Is it to guide others on improving their coding skills, raise awareness about an issue in the tech community, or display your progress in learning a new programming language?"]}),"\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.strong,{children:"End with a call-to-action"}),": Encourage readers to read and engage with the post."]}),"\n"]}),"\n",(0,o.jsx)(t.h2,{id:"repository-insights-connecting-your-repositories",children:"Repository Insights: Connecting Your Repositories"}),"\n",(0,o.jsxs)(t.p,{children:["OpenSauced ",(0,o.jsx)(t.a,{href:"/features/repo-insights",children:"Repository Insights"})," allows you to track open source projects you are interested in. You can use Repository Insights Pages to track repositories' growth, analyze work, and connect with others."]}),"\n",(0,o.jsx)(t.h3,{id:"why-create-a-repository-insights-page",children:"Why Create a Repository Insights Page"}),"\n",(0,o.jsxs)(t.ul,{children:["\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.strong,{children:"To track projects you're working on"}),": Tracking projects you're working on can help you stay up-to-date with the latest activity, trends, and connect with other contributors."]}),"\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.strong,{children:"To identify potential projects to contribute to"}),': If you\'re looking for a new project to contribute to, you can use the Repository Insights feature to track active projects that are looking for contributors. You can use the "Explore" tab to find new projects to contribute to and track them with your Repository Insights page.']}),"\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.strong,{children:"To network and engage with the community"}),': Finding people to work and connect with can be challenging. You can connect with your network through the feature\'s "Contributors" tab.']}),"\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.strong,{children:"To track the activity of a topic you're interested in"}),": Keeping up with the latest trends and activity in a particular topic can be challenging. You can use the Repository Insights feature to track the activity of a specific topic and find new projects to contribute to. For example, you can create a ",(0,o.jsx)(t.a,{href:"https://app.opensauced.pizza/pages/BekahHW/1055/dashboard",children:"Repository Insight Page for Active AI Repositories"}),"."]}),"\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.strong,{children:"To track the activity of your favorite programming languages"}),": If you're interested in tracking the activity of your favorite programming languages, you can use the Repository Insights feature to track the open source projects that are using them."]}),"\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.strong,{children:"To aid in the job search"}),": If you're looking for a job, you can use the Repository Insights feature to track the activity of the organizations you're interested in working on. This can help you understand the activity level of the repositories and the types of contributions being made, and even identify which company you want to contribute to."]}),"\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.strong,{children:"Curating collections for interest groups"}),": You can curate and share repositories focusing on sectors and programming languages that interest you."]}),"\n"]}),"\n",(0,o.jsx)(t.h3,{id:"creating-a-new-repository-insight-page",children:"Creating a New Repository Insight Page"}),"\n",(0,o.jsx)(t.p,{children:'To track the repositories, click the "+" next to "Insights" in the sidebar, then select "New Repository Insight." You will be redirected to a page where you can create your new Repository Insight Page.'}),"\n",(0,o.jsx)(t.p,{children:"There are two ways to add repositories to your Repository Insight Page:"}),"\n",(0,o.jsxs)(t.ol,{children:["\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.strong,{children:"Sync GitHub organization"}),": Syncing your GitHub organizations is a good idea if you want to keep track of their open source project activities and trends."]}),"\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.strong,{children:"Connect individual repositories"}),": Connecting individual repositories is a good idea if you want to keep track of the contributions of a specific repository or group of repositories."]}),"\n"]}),"\n",(0,o.jsx)(t.p,{children:(0,o.jsx)(t.img,{alt:"sync Repository Insights gif",src:i(709).A+"",width:"960",height:"543"})}),"\n",(0,o.jsx)(t.h3,{id:"using-your-repository-insights-page",children:"Using Your Repository Insights Page"}),"\n",(0,o.jsx)(t.p,{children:"Once you have connected your repositories, you will be redirected to your Repository Insight Page. Here, you will see a dashboard with an overview of the repositories and the contributors who have contributed to them."}),"\n",(0,o.jsx)(t.p,{children:"There are three tabs that provide you with more information on these repositories:"}),"\n",(0,o.jsx)(t.h4,{id:"repositories-dashboard",children:"Repositories Dashboard"}),"\n",(0,o.jsx)(t.p,{children:"If you're looking for an active project to contribute to, this tab can help you as it contains information such as activity levels, PR overview, PR velocity, spam PRs, contributors, and activity stats over the last 30 days. This information is also a good way to connect with others on the project or where to find support."}),"\n",(0,o.jsx)(t.p,{children:(0,o.jsx)(t.img,{alt:"repositories tab",src:i(4394).A+"",width:"1148",height:"796"})}),"\n",(0,o.jsx)(t.h4,{id:"contributors",children:"Contributors"}),"\n",(0,o.jsx)(t.p,{children:'The "Contributors" tab allows you to view more detailed information about other contributors, including activity levels, the number of repositories they contributed to, the date of their last contribution, their most used language, their time zone, the number of contributions, and their activity stats over the last 30 days. This can be a great way to find others to collaborate with or recommend for jobs.'}),"\n",(0,o.jsx)(t.p,{children:(0,o.jsx)(t.img,{alt:"contributors insight list",src:i(9333).A+"",width:"1212",height:"628"})}),"\n",(0,o.jsx)(t.admonition,{type:"tip",children:(0,o.jsx)(t.p,{children:"Want to learn more about your peers? You can select and add them to a Contributor Insight Page."})}),"\n",(0,o.jsx)(t.admonition,{type:"note",children:(0,o.jsxs)(t.p,{children:["To learn and understand more about the data provided, see ",(0,o.jsx)(t.a,{href:"/maintainers/understanding-repo-insights",children:"Understanding Repository Insights Data"}),"."]})}),"\n",(0,o.jsx)(t.h4,{id:"activity",children:"Activity"}),"\n",(0,o.jsx)(t.p,{children:"The \"Activity\" tab shows a graph of the last time each contributor created their PR and how many lines of code they've touched. It also provides more detailed information on each contributor when you hover over their image, including their latest PRs and repositories they've contributed to. Clicking their image will bring you to their profile on OpenSauced."}),"\n",(0,o.jsx)(t.p,{children:"This information can help you find potential repositories to contribute to and peers to collaborate with or ask for mentorship."}),"\n",(0,o.jsx)(t.p,{children:(0,o.jsx)(t.img,{alt:"activity graph",src:i(3046).A+"",width:"1592",height:"791"})}),"\n",(0,o.jsx)(t.h2,{id:"contributor-insights-connecting-with-contributors",children:"Contributor Insights: Connecting with Contributors"}),"\n",(0,o.jsxs)(t.p,{children:["The ",(0,o.jsx)(t.a,{href:"/features/contributor-insights",children:"Contributor Insights"})," feature helps you connect with other contributors or learn more about what others are up to in open source. With this feature, you can categorize, watch, and check out different groups of contributors within open source projects."]}),"\n",(0,o.jsx)(t.h3,{id:"what-you-can-do-with-contributor-insights",children:"What You can do with Contributor Insights?"}),"\n",(0,o.jsx)(t.p,{children:"There are many things you can do with this feature, but here are some ideas to get you started:"}),"\n",(0,o.jsxs)(t.ul,{children:["\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.strong,{children:"Track personal contributions"}),": If you create a list of your personal contributions, you can track them and see how you're doing over time, as well as get a breakdown of the type of contributions you're making, including commits, created PRs, reviewed PRs, and created issues."]}),"\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.strong,{children:"Learn about what other contributors are doing in open source"}),": You can learn where other contributors are contributing, what they're working on, and how active they are in the open source community."]}),"\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.strong,{children:"See who's using the OpenSauced Highlights feature"}),": You can see who's using the Highlights feature and show them support by giving an emoji reaction."]}),"\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.strong,{children:"Track contributors for job opportunities"}),": If you're looking for a job, you can track the activity of the contributors you're interested in working with. This helps you understand the activity level of the repositories and the types of contributions being made, and you can even identify which company you want to contribute to."]}),"\n"]}),"\n",(0,o.jsx)(t.h3,{id:"creating-a-new-contributor-insights-page",children:"Creating a New Contributor Insights Page"}),"\n",(0,o.jsxs)(t.ol,{children:["\n",(0,o.jsx)(t.li,{children:'Click the "+" next to "Insights" in your sidebar.'}),"\n",(0,o.jsx)(t.li,{children:'Select "New Contributor Insight" to start a new Contributor Insight Page.'}),"\n",(0,o.jsx)(t.li,{children:"Give your page a name."}),"\n",(0,o.jsx)(t.li,{children:"Add contributors to your page by searching for their GitHub username, syncing your GitHub Team, or importing your GitHub Following."}),"\n",(0,o.jsx)(t.li,{children:"Once your page is created, you can edit and choose to make it public or private. By default, it is set to public. To create a private page, you can upgrade your account to a paid plan."}),"\n"]}),"\n",(0,o.jsx)(t.p,{children:(0,o.jsx)(t.img,{alt:"contribution sync gif",src:i(8896).A+"",width:"1324",height:"1030"})}),"\n",(0,o.jsx)(t.h2,{id:"using-your-contributor-insights-page",children:"Using Your Contributor Insights Page"}),"\n",(0,o.jsx)(t.p,{children:"Once you have created your list, you will be redirected to your Contributor Insights Page. Here, you will see a dashboard with an overview of the contributors."}),"\n",(0,o.jsx)(t.p,{children:"There are three tabs that provide you with more information on these repositories:"}),"\n",(0,o.jsx)(t.h3,{id:"overview",children:"Overview"}),"\n",(0,o.jsxs)(t.p,{children:['The "Overview" tab gives you a high-level view of the contributors in your list, including the total number of commits in the last 30 days and the types of contributors: ',(0,o.jsx)(t.a,{href:"/welcome/glossary#active-contributors",children:"Active"}),", ",(0,o.jsx)(t.a,{href:"/welcome/glossary#new-contributors",children:"New"}),", and ",(0,o.jsx)(t.a,{href:"/welcome/glossary#alumni-contributors",children:"Alumni"}),"."]}),"\n",(0,o.jsx)(t.h3,{id:"activity-1",children:"Activity"}),"\n",(0,o.jsx)(t.p,{children:'The "Activity" tab gives you a graph view with more detailed information on each contributor, including the type of activity, repositories they\'ve contributed to, and how they compare to each other.'}),"\n",(0,o.jsx)(t.p,{children:"You can filter your Contributor Insight Page by All Contributors, Active Contributors, New Contributors, and Alumni Contributors."}),"\n",(0,o.jsx)(t.p,{children:(0,o.jsx)(t.img,{alt:"list graph",src:i(9834).A+"",width:"1263",height:"781"})}),"\n",(0,o.jsx)(t.h3,{id:"highlights",children:"Highlights"}),"\n",(0,o.jsx)(t.p,{children:'The "Highlights" tab gives you a list of the highlights that the contributors listed on your page have created. This is a great way to see what other contributors are up to and to show them support.'}),"\n",(0,o.jsx)(t.admonition,{type:"note",children:(0,o.jsxs)(t.p,{children:["To learn and understand more about the data provided, see ",(0,o.jsx)(t.a,{href:"/maintainers/understanding-contribs-insights",children:"Understanding Contributor Insights Data"}),"."]})}),"\n",(0,o.jsx)(t.h2,{id:"takeaways",children:"Takeaways"}),"\n",(0,o.jsxs)(t.ul,{children:["\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.strong,{children:"Create Your Profile"}),": Creating your profile is a great way to display your open source contributions, connect with other contributors and maintainers, and share during a job search."]}),"\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.strong,{children:"Explore"}),': The "Explore" tab is a great place to find new open source projects to contribute to.']}),"\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.strong,{children:"Highlights"}),": Leveraging OpenSauced's Highlights feature is a great way for you to showcase your valuable contributions to open source projects."]}),"\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.strong,{children:"Repository Insights"}),": OpenSauced Repository Insights feature allows you to track open source projects you are interested in."]}),"\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.strong,{children:"Contributor Insights"}),": The Contributor Insights feature helps you understand other contributors or track your own work in open source."]}),"\n"]}),"\n",(0,o.jsx)(t.h2,{id:"conclusion",children:"Conclusion"}),"\n",(0,o.jsx)(t.p,{children:"We hope this guide has helped you get started with OpenSauced and that you're excited to use the platform to connect with other contributors and maintainers, track your contributions, and find new open source projects to contribute to. If you have any questions or need help, please don't hesitate to reach out to us. We're here to help you succeed in your open source journey."})]})}function u(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},8896:(e,t,i)=>{i.d(t,{A:()=>o});const o=i.p+"assets/images/contributors-sync-list-b427c1971ecbd190a472a1a061bf63a6.gif"},9001:(e,t,i)=>{i.d(t,{A:()=>o});const o=i.p+"assets/images/highlight-e3a2da2446fe91467a31d225755bf40a.gif"},709:(e,t,i)=>{i.d(t,{A:()=>o});const o=i.p+"assets/images/insight-page-demo-cc2291df69361b2d476ccffcdbd1ee25.gif"},3046:(e,t,i)=>{i.d(t,{A:()=>o});const o=i.p+"assets/images/activity-repos-insights-3734baf3ab38356a4de96d43dde41a3d.png"},9333:(e,t,i)=>{i.d(t,{A:()=>o});const o=i.p+"assets/images/contributors-insights-1bc09dd6a32c3a16eba8b63ec351157f.png"},7718:(e,t,i)=>{i.d(t,{A:()=>o});const o=i.p+"assets/images/highlights-fcc750f036bb2ea7c11166c8338d7f6c.png"},9834:(e,t,i)=>{i.d(t,{A:()=>o});const o=i.p+"assets/images/list-graph-e2718b080f8d3af7e28011a6f064f46e.png"},6726:(e,t,i)=>{i.d(t,{A:()=>o});const o=i.p+"assets/images/profile-d4fae85bbb516b6a5b5837a3d137c223.png"},4394:(e,t,i)=>{i.d(t,{A:()=>o});const o=i.p+"assets/images/repos-insights-2db5d8c668cee2f528f47ae986d664c7.png"},1102:(e,t,i)=>{i.d(t,{A:()=>o});const o=i.p+"assets/images/settings-748558f026c2a0b1c23cbb3648bf3a05.png"},8453:(e,t,i)=>{i.d(t,{R:()=>s,x:()=>a});var o=i(6540);const n={},r=o.createContext(n);function s(e){const t=o.useContext(r);return o.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:s(e.components),o.createElement(r.Provider,{value:t},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/9b3a7c99.c49250bc.js b/assets/js/9b3a7c99.c49250bc.js
new file mode 100644
index 00000000..b1abcc74
--- /dev/null
+++ b/assets/js/9b3a7c99.c49250bc.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunk_open_sauced_docs_opensauced_pizza=self.webpackChunk_open_sauced_docs_opensauced_pizza||[]).push([[6738],{7150:(e,t,i)=>{i.r(t),i.d(t,{assets:()=>c,contentTitle:()=>s,default:()=>u,frontMatter:()=>r,metadata:()=>a,toc:()=>h});var o=i(4848),n=i(8453);const r={id:"contributors-guide-to-open-sauced",title:"Contributors Guide to OpenSauced",sidebar_label:"Contributors Guide to OpenSauced",keywords:["contributors","guides"]},s=void 0,a={id:"contributors/contributors-guide-to-open-sauced",title:"Contributors Guide to OpenSauced",description:"Introduction to OpenSauced for Contributors",source:"@site/docs/contributors/contributors-guide.md",sourceDirName:"contributors",slug:"/contributors/contributors-guide-to-open-sauced",permalink:"/contributors/contributors-guide-to-open-sauced",draft:!1,unlisted:!1,editUrl:"https://github.com/open-sauced/docs.opensauced.pizza/edit/main/docs/contributors/contributors-guide.md",tags:[],version:"current",lastUpdatedBy:"BekahHW",lastUpdatedAt:1717170876e3,frontMatter:{id:"contributors-guide-to-open-sauced",title:"Contributors Guide to OpenSauced",sidebar_label:"Contributors Guide to OpenSauced",keywords:["contributors","guides"]},sidebar:"docs",previous:{title:"Understanding Contributor Insights Data",permalink:"/maintainers/understanding-contribs-insights"},next:{title:"Welcome to the Community",permalink:"/community/welcome-to-the-community"}},c={},h=[{value:"Introduction to OpenSauced for Contributors",id:"introduction-to-opensauced-for-contributors",level:2},{value:"Getting Started",id:"getting-started",level:2},{value:"Creating Your Profile",id:"creating-your-profile",level:2},{value:"Your Profile",id:"your-profile",level:3},{value:"Explore: Finding Your Next Open Source Project",id:"explore-finding-your-next-open-source-project",level:2},{value:"Highlights: Connecting and Recognizing Contributions",id:"highlights-connecting-and-recognizing-contributions",level:2},{value:"Creating a New Highlight",id:"creating-a-new-highlight",level:3},{value:"Writing an Effective Highlight",id:"writing-an-effective-highlight",level:3},{value:"Highlighting Issues",id:"highlighting-issues",level:4},{value:"Highlighting PRs",id:"highlighting-prs",level:4},{value:"Highlighting Blog Posts",id:"highlighting-blog-posts",level:4},{value:"Repository Insights: Connecting Your Repositories",id:"repository-insights-connecting-your-repositories",level:2},{value:"Why Create a Repository Insights Page",id:"why-create-a-repository-insights-page",level:3},{value:"Creating a New Repository Insight Page",id:"creating-a-new-repository-insight-page",level:3},{value:"Using Your Repository Insights Page",id:"using-your-repository-insights-page",level:3},{value:"Repositories Dashboard",id:"repositories-dashboard",level:4},{value:"Contributors",id:"contributors",level:4},{value:"Activity",id:"activity",level:4},{value:"Contributor Insights: Connecting with Contributors",id:"contributor-insights-connecting-with-contributors",level:2},{value:"What You can do with Contributor Insights?",id:"what-you-can-do-with-contributor-insights",level:3},{value:"Creating a New Contributor Insights Page",id:"creating-a-new-contributor-insights-page",level:3},{value:"Using Your Contributor Insights Page",id:"using-your-contributor-insights-page",level:2},{value:"Overview",id:"overview",level:3},{value:"Activity",id:"activity-1",level:3},{value:"Highlights",id:"highlights",level:3},{value:"Takeaways",id:"takeaways",level:2},{value:"Conclusion",id:"conclusion",level:2}];function l(e){const t={a:"a",admonition:"admonition",h2:"h2",h3:"h3",h4:"h4",img:"img",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,n.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(t.h2,{id:"introduction-to-opensauced-for-contributors",children:"Introduction to OpenSauced for Contributors"}),"\n",(0,o.jsx)(t.p,{children:"OpenSauced is a platform dedicated to empowering you, the contributor, in your open source journey. With OpenSauced, you can find repositories to contribute to, track your contributions, gain insights into your favorite open source projects, and find new contributors to connect with."}),"\n",(0,o.jsx)(t.h2,{id:"getting-started",children:"Getting Started"}),"\n",(0,o.jsxs)(t.p,{children:["To get started, you will need to create an account on OpenSauced. You can do this by visiting the ",(0,o.jsx)(t.a,{href:"https://app.opensauced.pizza",children:"app.opensauced.pizza"}),' and clicking the "Connect with GitHub" button. You will be prompted to sign in with your GitHub account. Once you have signed in, you will be redirected to the OpenSauced dashboard. The best place to get started is by creating your profile.']}),"\n",(0,o.jsx)(t.h2,{id:"creating-your-profile",children:"Creating Your Profile"}),"\n",(0,o.jsx)(t.p,{children:"Creating your profile is a great way to showcase your open source contributions, connect with other contributors and maintainers, and share during a job search. Here are some steps to help you get started:"}),"\n",(0,o.jsxs)(t.ol,{children:["\n",(0,o.jsxs)(t.li,{children:["\n",(0,o.jsx)(t.p,{children:'After creating your account, navigate to "Settings."'}),"\n",(0,o.jsx)(t.p,{children:(0,o.jsx)(t.img,{alt:"settings",src:i(1102).A+"",width:"746",height:"178"})}),"\n"]}),"\n",(0,o.jsxs)(t.li,{children:["\n",(0,o.jsx)(t.p,{children:"Once there, you will be asked to add your name, bio, links to your social media accounts, timezone, and other forms of contact information."}),"\n",(0,o.jsx)(t.admonition,{type:"tip",children:(0,o.jsx)(t.p,{children:"Don't forget to add your personal site, GitHub Sponsors URL, and LinkedIn so people can connect with you and learn more about your work."})}),"\n"]}),"\n",(0,o.jsxs)(t.li,{children:["\n",(0,o.jsx)(t.p,{children:'In the "Interests" section, select the various programming languages and topics you are interested in. Setting them helps us recommend open source projects that fit your interests.'}),"\n"]}),"\n",(0,o.jsxs)(t.li,{children:["\n",(0,o.jsx)(t.p,{children:"Manage your email preferences."}),"\n"]}),"\n"]}),"\n",(0,o.jsx)(t.h3,{id:"your-profile",children:"Your Profile"}),"\n",(0,o.jsx)(t.p,{children:"Your profile is a great resource for showcasing your contributions and sharing your open source work with others."}),"\n",(0,o.jsx)(t.p,{children:(0,o.jsx)(t.img,{alt:"your profile",src:i(6726).A+"",width:"955",height:"994"})}),"\n",(0,o.jsxs)(t.p,{children:['On your profile, you will see the "Highlights" tab, which you can learn more about ',(0,o.jsx)(t.a,{href:"#highlights-connecting-and-recognizing-contributions",children:"in this section"}),", and three other tabs:"]}),"\n",(0,o.jsxs)(t.ul,{children:["\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.strong,{children:"Contributions"}),": This tab includes a graph showing the number of PRs you have opened, ",(0,o.jsx)(t.a,{href:"/welcome/glossary#pr-velocity",children:"the velocity of your PRs"}),', and the number of repositories you have contributed to. Underneath the graph is a "Latest PRs" chart, which shows a list of current and recent PRs. This tab is helpful if you want to showcase a steady and consistent open source contribution experience.']}),"\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.strong,{children:"Connections"}),": For pro accounts, you can reach out to other contributors and maintainers to collaborate on projects or to learn from them."]}),"\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.strong,{children:"Recommendations"}),': This tab includes a list of open source projects that are chosen based on the programming languages you picked in the "Interests" section of your public profile. It is useful if you\'re looking for new projects to contribute to.']}),"\n"]}),"\n",(0,o.jsx)(t.h2,{id:"explore-finding-your-next-open-source-project",children:"Explore: Finding Your Next Open Source Project"}),"\n",(0,o.jsx)(t.p,{children:'The "Explore" tab is a great place to start if you\'re looking for a new open source project to contribute to or want to find repositories for potential job opportunities. Here, you can find a list of open source projects and filter them by language, top repos, recent, most active, and more.'}),"\n",(0,o.jsx)(t.p,{children:"Once you've selected your filters, you'll be able to see the contributors, spam, and activity levels of the repository. Understanding a repository's activity level and PR velocity can help you determine if it's a good fit for you to contribute to and what to expect when you submit a PR."}),"\n",(0,o.jsxs)(t.p,{children:['For example, if you wanted to look for a JavaScript project to contribute to, you would select "JavaScript" from the language dropdown and "Most Active" from the filter dropdown to see the most active JavaScript projects on GitHub. If you want to keep track of the repositories you\'re interested in contributing to, you can select and add them to your ',(0,o.jsx)(t.a,{href:"/features/repo-insights",children:"Repository Insights Page"}),"."]}),"\n",(0,o.jsx)(t.h2,{id:"highlights-connecting-and-recognizing-contributions",children:"Highlights: Connecting and Recognizing Contributions"}),"\n",(0,o.jsxs)(t.p,{children:["Leveraging OpenSauced's ",(0,o.jsx)(t.a,{href:"/features/highlights",children:"Highlights"})," feature is a great way for you to showcase your valuable contributions to open source projects. You can curate and share your achievements and milestones and bring visibility to your hard work."]}),"\n",(0,o.jsx)(t.p,{children:"The Highlights feature allows you to:"}),"\n",(0,o.jsxs)(t.ul,{children:["\n",(0,o.jsx)(t.li,{children:"talk about issues that you raised,"}),"\n",(0,o.jsx)(t.li,{children:"share blog posts that you've written,"}),"\n",(0,o.jsx)(t.li,{children:"display PRs that showcase your contributions."}),"\n"]}),"\n",(0,o.jsx)(t.h3,{id:"creating-a-new-highlight",children:"Creating a New Highlight"}),"\n",(0,o.jsx)(t.p,{children:"There are two ways to create a new highlight:"}),"\n",(0,o.jsxs)(t.ol,{children:["\n",(0,o.jsx)(t.li,{children:"Paste the URL to your PR, issue, or blog post (shown in blue below)."}),"\n",(0,o.jsx)(t.li,{children:"Choose from a list of suggestions (shown in orange below)."}),"\n"]}),"\n",(0,o.jsx)(t.p,{children:(0,o.jsx)(t.img,{alt:"highlight suggestions",src:i(7718).A+"",width:"626",height:"633"})}),"\n",(0,o.jsx)(t.admonition,{type:"note",children:(0,o.jsx)(t.p,{children:"If you're adding a blog post, you'll need to associate it to a repository by clicking the \"Add a repo\" button."})}),"\n",(0,o.jsx)(t.p,{children:"Finally, it's time to add the details of your highlight. You can write the description yourself or use the auto-summarize button to generate one."}),"\n",(0,o.jsx)(t.p,{children:(0,o.jsx)(t.img,{alt:"gif of creating a highlight",src:i(9001).A+"",width:"2294",height:"1066"})}),"\n",(0,o.jsx)(t.h3,{id:"writing-an-effective-highlight",children:"Writing an Effective Highlight"}),"\n",(0,o.jsx)(t.p,{children:"Sharing the story of your hard work is an opportunity to connect with the reader, which could include potential collaborators or recruiters. Here are some tips to help you write effective stories for your highlights:"}),"\n",(0,o.jsx)(t.h4,{id:"highlighting-issues",children:"Highlighting Issues"}),"\n",(0,o.jsxs)(t.ol,{children:["\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.strong,{children:"Share your motivation"}),': Briefly explain why you raised the issue. For example, "I\'m passionate about improving accessibility because I believe everyone should have equal access to information."']}),"\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.strong,{children:"Summarize the issue"}),": Briefly describe the issue you wrote so your readers have context. For example, \"I raised an issue to add alt text to images in the project's 'About Us' page.\""]}),"\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.strong,{children:"Describe the impact:"}),' Briefly state how the resolution of the issue will improve the project. For example, "This will help people who use screen readers to understand the content of the images."']}),"\n"]}),"\n",(0,o.jsx)(t.h4,{id:"highlighting-prs",children:"Highlighting PRs"}),"\n",(0,o.jsxs)(t.ol,{children:["\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.strong,{children:"Describe the PR"}),': Start with a clear summary of what your PR accomplishes. For example, "I added a new feature to the project\'s Chrome Extension that allows users to summarize content."']}),"\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.strong,{children:"Highlight your solution and its impact"}),': Briefly describe the solution, any challenges you faced, or any part of the PR you\'re particularly proud of. For example, "Initially, I faced challenges with the API, but I was able to resolve them using a different endpoint."']}),"\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.strong,{children:"Reflect on your experience"}),': Mention what you learned from working on the PR. For example, "I learned a lot about the Chrome Extension API and how to use it to create new features."']}),"\n"]}),"\n",(0,o.jsx)(t.h4,{id:"highlighting-blog-posts",children:"Highlighting Blog Posts"}),"\n",(0,o.jsxs)(t.ol,{children:["\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.strong,{children:"Describe the topic"}),": Begin with an interesting blog post summary to help your peers and potential recruiters understand your writing."]}),"\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.strong,{children:"Discuss the inspiration"}),": Explain why you wrote this blog post. Is it to guide others on improving their coding skills, raise awareness about an issue in the tech community, or display your progress in learning a new programming language?"]}),"\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.strong,{children:"End with a call-to-action"}),": Encourage readers to read and engage with the post."]}),"\n"]}),"\n",(0,o.jsx)(t.h2,{id:"repository-insights-connecting-your-repositories",children:"Repository Insights: Connecting Your Repositories"}),"\n",(0,o.jsxs)(t.p,{children:["OpenSauced ",(0,o.jsx)(t.a,{href:"/features/repo-insights",children:"Repository Insights"})," allows you to track open source projects you are interested in. You can use Repository Insights Pages to track repositories' growth, analyze work, and connect with others."]}),"\n",(0,o.jsx)(t.h3,{id:"why-create-a-repository-insights-page",children:"Why Create a Repository Insights Page"}),"\n",(0,o.jsxs)(t.ul,{children:["\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.strong,{children:"To track projects you're working on"}),": Tracking projects you're working on can help you stay up-to-date with the latest activity, trends, and connect with other contributors."]}),"\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.strong,{children:"To identify potential projects to contribute to"}),': If you\'re looking for a new project to contribute to, you can use the Repository Insights feature to track active projects that are looking for contributors. You can use the "Explore" tab to find new projects to contribute to and track them with your Repository Insights page.']}),"\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.strong,{children:"To network and engage with the community"}),': Finding people to work and connect with can be challenging. You can connect with your network through the feature\'s "Contributors" tab.']}),"\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.strong,{children:"To track the activity of a topic you're interested in"}),": Keeping up with the latest trends and activity in a particular topic can be challenging. You can use the Repository Insights feature to track the activity of a specific topic and find new projects to contribute to. For example, you can create a ",(0,o.jsx)(t.a,{href:"https://app.opensauced.pizza/pages/BekahHW/1055/dashboard",children:"Repository Insight Page for Active AI Repositories"}),"."]}),"\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.strong,{children:"To track the activity of your favorite programming languages"}),": If you're interested in tracking the activity of your favorite programming languages, you can use the Repository Insights feature to track the open source projects that are using them."]}),"\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.strong,{children:"To aid in the job search"}),": If you're looking for a job, you can use the Repository Insights feature to track the activity of the organizations you're interested in working on. This can help you understand the activity level of the repositories and the types of contributions being made, and even identify which company you want to contribute to."]}),"\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.strong,{children:"Curating collections for interest groups"}),": You can curate and share repositories focusing on sectors and programming languages that interest you."]}),"\n"]}),"\n",(0,o.jsx)(t.h3,{id:"creating-a-new-repository-insight-page",children:"Creating a New Repository Insight Page"}),"\n",(0,o.jsx)(t.p,{children:'To track the repositories, click the "+" next to "Insights" in the sidebar, then select "New Repository Insight." You will be redirected to a page where you can create your new Repository Insight Page.'}),"\n",(0,o.jsx)(t.p,{children:"There are two ways to add repositories to your Repository Insight Page:"}),"\n",(0,o.jsxs)(t.ol,{children:["\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.strong,{children:"Sync GitHub organization"}),": Syncing your GitHub organizations is a good idea if you want to keep track of their open source project activities and trends."]}),"\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.strong,{children:"Connect individual repositories"}),": Connecting individual repositories is a good idea if you want to keep track of the contributions of a specific repository or group of repositories."]}),"\n"]}),"\n",(0,o.jsx)(t.p,{children:(0,o.jsx)(t.img,{alt:"sync Repository Insights gif",src:i(709).A+"",width:"960",height:"543"})}),"\n",(0,o.jsx)(t.h3,{id:"using-your-repository-insights-page",children:"Using Your Repository Insights Page"}),"\n",(0,o.jsx)(t.p,{children:"Once you have connected your repositories, you will be redirected to your Repository Insight Page. Here, you will see a dashboard with an overview of the repositories and the contributors who have contributed to them."}),"\n",(0,o.jsx)(t.p,{children:"There are three tabs that provide you with more information on these repositories:"}),"\n",(0,o.jsx)(t.h4,{id:"repositories-dashboard",children:"Repositories Dashboard"}),"\n",(0,o.jsx)(t.p,{children:"If you're looking for an active project to contribute to, this tab can help you as it contains information such as activity levels, PR overview, PR velocity, spam PRs, contributors, and activity stats over the last 30 days. This information is also a good way to connect with others on the project or where to find support."}),"\n",(0,o.jsx)(t.p,{children:(0,o.jsx)(t.img,{alt:"repositories tab",src:i(4394).A+"",width:"1148",height:"796"})}),"\n",(0,o.jsx)(t.h4,{id:"contributors",children:"Contributors"}),"\n",(0,o.jsx)(t.p,{children:'The "Contributors" tab allows you to view more detailed information about other contributors, including activity levels, the number of repositories they contributed to, the date of their last contribution, their most used language, their time zone, the number of contributions, and their activity stats over the last 30 days. This can be a great way to find others to collaborate with or recommend for jobs.'}),"\n",(0,o.jsx)(t.p,{children:(0,o.jsx)(t.img,{alt:"contributors insight list",src:i(9333).A+"",width:"1212",height:"628"})}),"\n",(0,o.jsx)(t.admonition,{type:"tip",children:(0,o.jsx)(t.p,{children:"Want to learn more about your peers? You can select and add them to a Contributor Insight Page."})}),"\n",(0,o.jsx)(t.admonition,{type:"note",children:(0,o.jsxs)(t.p,{children:["To learn and understand more about the data provided, see ",(0,o.jsx)(t.a,{href:"/maintainers/understanding-repo-insights",children:"Understanding Repository Insights Data"}),"."]})}),"\n",(0,o.jsx)(t.h4,{id:"activity",children:"Activity"}),"\n",(0,o.jsx)(t.p,{children:"The \"Activity\" tab shows a graph of the last time each contributor created their PR and how many lines of code they've touched. It also provides more detailed information on each contributor when you hover over their image, including their latest PRs and repositories they've contributed to. Clicking their image will bring you to their profile on OpenSauced."}),"\n",(0,o.jsx)(t.p,{children:"This information can help you find potential repositories to contribute to and peers to collaborate with or ask for mentorship."}),"\n",(0,o.jsx)(t.p,{children:(0,o.jsx)(t.img,{alt:"activity graph",src:i(3046).A+"",width:"1592",height:"791"})}),"\n",(0,o.jsx)(t.h2,{id:"contributor-insights-connecting-with-contributors",children:"Contributor Insights: Connecting with Contributors"}),"\n",(0,o.jsxs)(t.p,{children:["The ",(0,o.jsx)(t.a,{href:"/features/contributor-insights",children:"Contributor Insights"})," feature helps you connect with other contributors or learn more about what others are up to in open source. With this feature, you can categorize, watch, and check out different groups of contributors within open source projects."]}),"\n",(0,o.jsx)(t.h3,{id:"what-you-can-do-with-contributor-insights",children:"What You can do with Contributor Insights?"}),"\n",(0,o.jsx)(t.p,{children:"There are many things you can do with this feature, but here are some ideas to get you started:"}),"\n",(0,o.jsxs)(t.ul,{children:["\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.strong,{children:"Track personal contributions"}),": If you create a list of your personal contributions, you can track them and see how you're doing over time, as well as get a breakdown of the type of contributions you're making, including commits, created PRs, reviewed PRs, and created issues."]}),"\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.strong,{children:"Learn about what other contributors are doing in open source"}),": You can learn where other contributors are contributing, what they're working on, and how active they are in the open source community."]}),"\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.strong,{children:"See who's using the OpenSauced Highlights feature"}),": You can see who's using the Highlights feature and show them support by giving an emoji reaction."]}),"\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.strong,{children:"Track contributors for job opportunities"}),": If you're looking for a job, you can track the activity of the contributors you're interested in working with. This helps you understand the activity level of the repositories and the types of contributions being made, and you can even identify which company you want to contribute to."]}),"\n"]}),"\n",(0,o.jsx)(t.h3,{id:"creating-a-new-contributor-insights-page",children:"Creating a New Contributor Insights Page"}),"\n",(0,o.jsxs)(t.ol,{children:["\n",(0,o.jsx)(t.li,{children:'Click the "+" next to "Insights" in your sidebar.'}),"\n",(0,o.jsx)(t.li,{children:'Select "New Contributor Insight" to start a new Contributor Insight Page.'}),"\n",(0,o.jsx)(t.li,{children:"Give your page a name."}),"\n",(0,o.jsx)(t.li,{children:"Add contributors to your page by searching for their GitHub username, syncing your GitHub Team, or importing your GitHub Following."}),"\n",(0,o.jsx)(t.li,{children:"Once your page is created, you can edit and choose to make it public or private. By default, it is set to public. To create a private page, you can upgrade your account to a paid plan."}),"\n"]}),"\n",(0,o.jsx)(t.p,{children:(0,o.jsx)(t.img,{alt:"contribution sync gif",src:i(8896).A+"",width:"1324",height:"1030"})}),"\n",(0,o.jsx)(t.h2,{id:"using-your-contributor-insights-page",children:"Using Your Contributor Insights Page"}),"\n",(0,o.jsx)(t.p,{children:"Once you have created your list, you will be redirected to your Contributor Insights Page. Here, you will see a dashboard with an overview of the contributors."}),"\n",(0,o.jsx)(t.p,{children:"There are three tabs that provide you with more information on these repositories:"}),"\n",(0,o.jsx)(t.h3,{id:"overview",children:"Overview"}),"\n",(0,o.jsxs)(t.p,{children:['The "Overview" tab gives you a high-level view of the contributors in your list, including the total number of commits in the last 30 days and the types of contributors: ',(0,o.jsx)(t.a,{href:"/welcome/glossary#active-contributors",children:"Active"}),", ",(0,o.jsx)(t.a,{href:"/welcome/glossary#new-contributors",children:"New"}),", and ",(0,o.jsx)(t.a,{href:"/welcome/glossary#alumni-contributors",children:"Alumni"}),"."]}),"\n",(0,o.jsx)(t.h3,{id:"activity-1",children:"Activity"}),"\n",(0,o.jsx)(t.p,{children:'The "Activity" tab gives you a graph view with more detailed information on each contributor, including the type of activity, repositories they\'ve contributed to, and how they compare to each other.'}),"\n",(0,o.jsx)(t.p,{children:"You can filter your Contributor Insight Page by All Contributors, Active Contributors, New Contributors, and Alumni Contributors."}),"\n",(0,o.jsx)(t.p,{children:(0,o.jsx)(t.img,{alt:"list graph",src:i(9834).A+"",width:"1263",height:"781"})}),"\n",(0,o.jsx)(t.h3,{id:"highlights",children:"Highlights"}),"\n",(0,o.jsx)(t.p,{children:'The "Highlights" tab gives you a list of the highlights that the contributors listed on your page have created. This is a great way to see what other contributors are up to and to show them support.'}),"\n",(0,o.jsx)(t.admonition,{type:"note",children:(0,o.jsxs)(t.p,{children:["To learn and understand more about the data provided, see ",(0,o.jsx)(t.a,{href:"/maintainers/understanding-contribs-insights",children:"Understanding Contributor Insights Data"}),"."]})}),"\n",(0,o.jsx)(t.h2,{id:"takeaways",children:"Takeaways"}),"\n",(0,o.jsxs)(t.ul,{children:["\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.strong,{children:"Create Your Profile"}),": Creating your profile is a great way to display your open source contributions, connect with other contributors and maintainers, and share during a job search."]}),"\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.strong,{children:"Explore"}),': The "Explore" tab is a great place to find new open source projects to contribute to.']}),"\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.strong,{children:"Highlights"}),": Leveraging OpenSauced's Highlights feature is a great way for you to showcase your valuable contributions to open source projects."]}),"\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.strong,{children:"Repository Insights"}),": OpenSauced Repository Insights feature allows you to track open source projects you are interested in."]}),"\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.strong,{children:"Contributor Insights"}),": The Contributor Insights feature helps you understand other contributors or track your own work in open source."]}),"\n"]}),"\n",(0,o.jsx)(t.h2,{id:"conclusion",children:"Conclusion"}),"\n",(0,o.jsx)(t.p,{children:"We hope this guide has helped you get started with OpenSauced and that you're excited to use the platform to connect with other contributors and maintainers, track your contributions, and find new open source projects to contribute to. If you have any questions or need help, please don't hesitate to reach out to us. We're here to help you succeed in your open source journey."})]})}function u(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},8896:(e,t,i)=>{i.d(t,{A:()=>o});const o=i.p+"assets/images/contributors-sync-list-b427c1971ecbd190a472a1a061bf63a6.gif"},9001:(e,t,i)=>{i.d(t,{A:()=>o});const o=i.p+"assets/images/highlight-e3a2da2446fe91467a31d225755bf40a.gif"},709:(e,t,i)=>{i.d(t,{A:()=>o});const o=i.p+"assets/images/insight-page-demo-cc2291df69361b2d476ccffcdbd1ee25.gif"},3046:(e,t,i)=>{i.d(t,{A:()=>o});const o=i.p+"assets/images/activity-repos-insights-3734baf3ab38356a4de96d43dde41a3d.png"},9333:(e,t,i)=>{i.d(t,{A:()=>o});const o=i.p+"assets/images/contributors-insights-1bc09dd6a32c3a16eba8b63ec351157f.png"},7718:(e,t,i)=>{i.d(t,{A:()=>o});const o=i.p+"assets/images/highlights-fcc750f036bb2ea7c11166c8338d7f6c.png"},9834:(e,t,i)=>{i.d(t,{A:()=>o});const o=i.p+"assets/images/list-graph-e2718b080f8d3af7e28011a6f064f46e.png"},6726:(e,t,i)=>{i.d(t,{A:()=>o});const o=i.p+"assets/images/profile-d4fae85bbb516b6a5b5837a3d137c223.png"},4394:(e,t,i)=>{i.d(t,{A:()=>o});const o=i.p+"assets/images/repos-insights-2db5d8c668cee2f528f47ae986d664c7.png"},1102:(e,t,i)=>{i.d(t,{A:()=>o});const o=i.p+"assets/images/settings-748558f026c2a0b1c23cbb3648bf3a05.png"},8453:(e,t,i)=>{i.d(t,{R:()=>s,x:()=>a});var o=i(6540);const n={},r=o.createContext(n);function s(e){const t=o.useContext(r);return o.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:s(e.components),o.createElement(r.Provider,{value:t},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/a09c2993.ec69f808.js b/assets/js/a09c2993.b47c912e.js
similarity index 69%
rename from assets/js/a09c2993.ec69f808.js
rename to assets/js/a09c2993.b47c912e.js
index 5c05d492..10e87df1 100644
--- a/assets/js/a09c2993.ec69f808.js
+++ b/assets/js/a09c2993.b47c912e.js
@@ -1 +1 @@
-"use strict";(self.webpackChunk_open_sauced_docs_opensauced_pizza=self.webpackChunk_open_sauced_docs_opensauced_pizza||[]).push([[5899],{1456:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>l,frontMatter:()=>s,metadata:()=>a,toc:()=>d});var o=t(4848),i=t(8453);const s={slug:"/",title:"Introduction to OpenSauced \ud83c\udf55",sidebar_label:"Introduction to OpenSauced \ud83c\udf55",keywords:["introduction","introduction to opensauced","opensauced introduction","get to know opensauced"]},r=void 0,a={id:"introduction",title:"Introduction to OpenSauced \ud83c\udf55",description:"Example banner",source:"@site/docs/introduction.md",sourceDirName:".",slug:"/",permalink:"/",draft:!1,unlisted:!1,editUrl:"https://github.com/open-sauced/docs.opensauced.pizza/edit/main/docs/introduction.md",tags:[],version:"current",lastUpdatedBy:"BekahHW",lastUpdatedAt:171701191e4,frontMatter:{slug:"/",title:"Introduction to OpenSauced \ud83c\udf55",sidebar_label:"Introduction to OpenSauced \ud83c\udf55",keywords:["introduction","introduction to opensauced","opensauced introduction","get to know opensauced"]},sidebar:"docs",next:{title:"What is OpenSauced?",permalink:"/welcome/opensauced-intro"}},c={},d=[];function u(e){const n={a:"a",admonition:"admonition",img:"img",li:"li",p:"p",strong:"strong",ul:"ul",...(0,i.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.p,{children:(0,o.jsx)(n.img,{alt:"Example banner",src:t(6939).A+"",width:"3340",height:"1874"})}),"\n",(0,o.jsx)(n.admonition,{type:"info",children:(0,o.jsxs)(n.p,{children:['You can watch "',(0,o.jsx)(n.a,{href:"https://www.youtube.com/watch?v=JCNjj19iDa4",children:"What is OpenSauced?"}),'" on YouTube.']})}),"\n",(0,o.jsx)(n.p,{children:"OpenSauced is a platform dedicated to empowering maintainers and teams and redefining the meaning of open source contributions. We believe that every contribution, big or small, is valuable and deserves to be recognized. Our platform provides a way to track contributions through a GitHub-powered dashboard, allowing users to showcase their contributions and gain insights into their open source projects."}),"\n",(0,o.jsx)(n.p,{children:"Our mission is to:"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.a,{href:"/maintainers/maintainers-guide-to-open-sauced",children:(0,o.jsx)(n.strong,{children:"Empower maintainers and teams"})}),": Track and showcase your contributions and projects, connect with contributors, collaborate with your team, and gain insights into your open source projects."]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.a,{href:"/contributors/contributors-guide-to-open-sauced",children:(0,o.jsx)(n.strong,{children:"Support contributors"})}),": Showcase your contributions, tell your story, connect with new projects and other contributors, and gain insights into your open source journey."]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.a,{href:"/features/highlights",children:(0,o.jsx)(n.strong,{children:"Highlight success"})}),": Showcase your contributions with our shareable Highlights, inspiring others to embark on their open source journey."]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.a,{href:"/features/repo-insights",children:(0,o.jsx)(n.strong,{children:"Unlock Insights"})}),": Understand the health of your project, track contributions, and make data-driven decisions with OpenSauced Insights."]}),"\n"]})]})}function l(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(u,{...e})}):u(e)}},6939:(e,n,t)=>{t.d(n,{A:()=>o});const o=t.p+"assets/images/what-is-opensauced-24-4972e89a8a801c565e494e6e317ff546.png"},8453:(e,n,t)=>{t.d(n,{R:()=>r,x:()=>a});var o=t(6540);const i={},s=o.createContext(i);function r(e){const n=o.useContext(s);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),o.createElement(s.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
+"use strict";(self.webpackChunk_open_sauced_docs_opensauced_pizza=self.webpackChunk_open_sauced_docs_opensauced_pizza||[]).push([[5899],{1456:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>l,frontMatter:()=>s,metadata:()=>a,toc:()=>d});var o=t(4848),i=t(8453);const s={slug:"/",title:"Introduction to OpenSauced \ud83c\udf55",sidebar_label:"Introduction to OpenSauced \ud83c\udf55",keywords:["introduction","introduction to opensauced","opensauced introduction","get to know opensauced"]},r=void 0,a={id:"introduction",title:"Introduction to OpenSauced \ud83c\udf55",description:"Example banner",source:"@site/docs/introduction.md",sourceDirName:".",slug:"/",permalink:"/",draft:!1,unlisted:!1,editUrl:"https://github.com/open-sauced/docs.opensauced.pizza/edit/main/docs/introduction.md",tags:[],version:"current",lastUpdatedBy:"BekahHW",lastUpdatedAt:1717170876e3,frontMatter:{slug:"/",title:"Introduction to OpenSauced \ud83c\udf55",sidebar_label:"Introduction to OpenSauced \ud83c\udf55",keywords:["introduction","introduction to opensauced","opensauced introduction","get to know opensauced"]},sidebar:"docs",next:{title:"What is OpenSauced?",permalink:"/welcome/opensauced-intro"}},c={},d=[];function u(e){const n={a:"a",admonition:"admonition",img:"img",li:"li",p:"p",strong:"strong",ul:"ul",...(0,i.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.p,{children:(0,o.jsx)(n.img,{alt:"Example banner",src:t(8222).A+"",width:"1920",height:"982"})}),"\n",(0,o.jsx)(n.admonition,{type:"info",children:(0,o.jsxs)(n.p,{children:['You can watch "',(0,o.jsx)(n.a,{href:"https://www.youtube.com/watch?v=JCNjj19iDa4",children:"What is OpenSauced?"}),'" on YouTube.']})}),"\n",(0,o.jsx)(n.p,{children:"OpenSauced is a platform dedicated to empowering maintainers and teams and redefining the meaning of open source contributions. We believe that every contribution, big or small, is valuable and deserves to be recognized. Our platform provides a way to track contributions through a GitHub-powered dashboard, allowing users to showcase their contributions and gain insights into their open source projects."}),"\n",(0,o.jsx)(n.p,{children:"Our mission is to:"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.a,{href:"/maintainers/maintainers-guide-to-open-sauced",children:(0,o.jsx)(n.strong,{children:"Empower maintainers and teams"})}),": Track and showcase your contributions and projects, connect with contributors, collaborate with your team, and gain insights into your open source projects."]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.a,{href:"/contributors/contributors-guide-to-open-sauced",children:(0,o.jsx)(n.strong,{children:"Support contributors"})}),": Showcase your contributions, tell your story, connect with new projects and other contributors, and gain insights into your open source journey."]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.a,{href:"/features/highlights",children:(0,o.jsx)(n.strong,{children:"Highlight success"})}),": Showcase your contributions with our shareable Highlights, inspiring others to embark on their open source journey."]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.a,{href:"/features/repo-insights",children:(0,o.jsx)(n.strong,{children:"Unlock Insights"})}),": Understand the health of your project, track contributions, and make data-driven decisions with OpenSauced Insights."]}),"\n"]})]})}function l(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(u,{...e})}):u(e)}},8222:(e,n,t)=>{t.d(n,{A:()=>o});const o=t.p+"assets/images/what-is-opensauced-f49a0d8ab20f4a65c54db29eff4e10d9.png"},8453:(e,n,t)=>{t.d(n,{R:()=>r,x:()=>a});var o=t(6540);const i={},s=o.createContext(i);function r(e){const n=o.useContext(s);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),o.createElement(s.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/a93463cf.27d60a76.js b/assets/js/a93463cf.27d60a76.js
deleted file mode 100644
index 0d45610a..00000000
--- a/assets/js/a93463cf.27d60a76.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunk_open_sauced_docs_opensauced_pizza=self.webpackChunk_open_sauced_docs_opensauced_pizza||[]).push([[1958],{8356:(t,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>l,frontMatter:()=>o,metadata:()=>a,toc:()=>c});var e=i(4848),s=i(8453);const o={id:"understanding-contribs-insights",title:"Understanding Contributor Insights Data",sidebar_label:"Understanding Contributor Insights Data",keywords:["maintainers","guides","Contributor Insights Analysis","List Data Exploration","Data Organization","Data Insight from Contributor Insights","List Visualization","Data Representation in Contributor Insights","List Data Interpretation","Organizing Data in Contributor Insights"]},r=void 0,a={id:"maintainers/understanding-contribs-insights",title:"Understanding Contributor Insights Data",description:"Once you've created your Contributor Insight Page, it's time to understand the data provided. Understanding this data is key to effectively managing your projects and contributors.",source:"@site/docs/maintainers/understanding-contrib-insights.md",sourceDirName:"maintainers",slug:"/maintainers/understanding-contribs-insights",permalink:"/maintainers/understanding-contribs-insights",draft:!1,unlisted:!1,editUrl:"https://github.com/open-sauced/docs.opensauced.pizza/edit/main/docs/maintainers/understanding-contrib-insights.md",tags:[],version:"current",lastUpdatedBy:"BekahHW",lastUpdatedAt:171701191e4,frontMatter:{id:"understanding-contribs-insights",title:"Understanding Contributor Insights Data",sidebar_label:"Understanding Contributor Insights Data",keywords:["maintainers","guides","Contributor Insights Analysis","List Data Exploration","Data Organization","Data Insight from Contributor Insights","List Visualization","Data Representation in Contributor Insights","List Data Interpretation","Organizing Data in Contributor Insights"]},sidebar:"docs",previous:{title:"Understanding Repo Insights Data",permalink:"/maintainers/understanding-repo-insights"},next:{title:"Contributors Guide to OpenSauced",permalink:"/contributors/contributors-guide-to-open-sauced"}},d={},c=[{value:"Understanding Contributor Insights Data",id:"understanding-contributor-insights-data",level:2},{value:"Interpreting Total Commits in the Last 30 Days",id:"interpreting-total-commits-in-the-last-30-days",level:3},{value:"Monitoring Active Contributors",id:"monitoring-active-contributors",level:3},{value:"Understanding Types of Contributors",id:"understanding-types-of-contributors",level:3},{value:"New Contributors",id:"new-contributors",level:4},{value:"Alumni Contributors",id:"alumni-contributors",level:4},{value:"Most Active Contributors",id:"most-active-contributors",level:4},{value:"Activity Across Other Repositories",id:"activity-across-other-repositories",level:3}];function u(t){const n={h2:"h2",h3:"h3",h4:"h4",p:"p",...(0,s.R)(),...t.components};return(0,e.jsxs)(e.Fragment,{children:[(0,e.jsx)(n.p,{children:"Once you've created your Contributor Insight Page, it's time to understand the data provided. Understanding this data is key to effectively managing your projects and contributors."}),"\n",(0,e.jsx)(n.h2,{id:"understanding-contributor-insights-data",children:"Understanding Contributor Insights Data"}),"\n",(0,e.jsx)(n.h3,{id:"interpreting-total-commits-in-the-last-30-days",children:"Interpreting Total Commits in the Last 30 Days"}),"\n",(0,e.jsx)(n.p,{children:"Understanding the commits over the last 30 days helps in gauging the overall activity and productivity of the group."}),"\n",(0,e.jsx)(n.p,{children:"High commit volume might indicate a highly active and engaged team. A sudden drop could signal potential issues or a need for additional support or motivation."}),"\n",(0,e.jsx)(n.h3,{id:"monitoring-active-contributors",children:"Monitoring Active Contributors"}),"\n",(0,e.jsx)(n.p,{children:"Identifying active contributors helps in recognizing reliable team members and planning future tasks."}),"\n",(0,e.jsx)(n.p,{children:"Trends in active contributor numbers can indicate the health of the project community and the effectiveness of engagement strategies. Notice the ebbs and flows in individual contributors\u2019 activity."}),"\n",(0,e.jsx)(n.p,{children:"A decline in a normally active contributor\u2019s engagement could indicate burnout or dissatisfaction, while a surge in activity might be tied to recent changes or enhancements in the project. Tracking activity levels can help you manage team burnout, understand resource needs, and spot potential issues before they escalate."}),"\n",(0,e.jsx)(n.h3,{id:"understanding-types-of-contributors",children:"Understanding Types of Contributors"}),"\n",(0,e.jsx)(n.h4,{id:"new-contributors",children:"New Contributors"}),"\n",(0,e.jsx)(n.p,{children:"Tracking new contributors is key to understanding the growth and influx of new talent."}),"\n",(0,e.jsx)(n.p,{children:"An influx of new contributors might be a positive sign of project popularity, successful outreach efforts, or the community health of your project. However, it could also indicate a need for more support and guidance for new contributors."}),"\n",(0,e.jsx)(n.h4,{id:"alumni-contributors",children:"Alumni Contributors"}),"\n",(0,e.jsx)(n.p,{children:"Alumni contributors are contributors who haven't been active in the last 30 days. Identifying contributors who have stopped contributing helps in assessing potential issues or dissatisfaction."}),"\n",(0,e.jsx)(n.p,{children:"High churn rates could signal deeper problems within the project environment or community management."}),"\n",(0,e.jsx)(n.h4,{id:"most-active-contributors",children:"Most Active Contributors"}),"\n",(0,e.jsx)(n.p,{children:"Identifying key contributors and potential leaders is important for project health and growth. It can help with delegation of responsibilities and recognition of top performers. It can also identify potential mentors for new contributors and help in planning for succession."}),"\n",(0,e.jsx)(n.p,{children:"If you see that a few active contributors are doing most of the work, it might be a sign that the project needs more support or that the workload needs to be better distributed."}),"\n",(0,e.jsx)(n.h3,{id:"activity-across-other-repositories",children:"Activity Across Other Repositories"}),"\n",(0,e.jsx)(n.p,{children:"Understanding the range of repositories to which contributors in a list have recently contributed shows the broader interests and skills of the community. It reveals contributors' engagement levels and potential specializations, which allows for effective task allocation and identifying mentorship or leadership candidates."}),"\n",(0,e.jsx)(n.p,{children:"Additionally, it opens paths for potential cross-project collaborations and strategic project planning, aligning the project\u2019s goals with trends and interests in the open source ecosystem."}),"\n",(0,e.jsx)(n.p,{children:"Understanding the recent history of each contributor's engagement assists in tracking individual contribution patterns and identifying potentially cooling interests."})]})}function l(t={}){const{wrapper:n}={...(0,s.R)(),...t.components};return n?(0,e.jsx)(n,{...t,children:(0,e.jsx)(u,{...t})}):u(t)}},8453:(t,n,i)=>{i.d(n,{R:()=>r,x:()=>a});var e=i(6540);const s={},o=e.createContext(s);function r(t){const n=e.useContext(o);return e.useMemo((function(){return"function"==typeof t?t(n):{...n,...t}}),[n,t])}function a(t){let n;return n=t.disableParentContext?"function"==typeof t.components?t.components(s):t.components||s:r(t.components),e.createElement(o.Provider,{value:n},t.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/a93463cf.2fc3a026.js b/assets/js/a93463cf.2fc3a026.js
new file mode 100644
index 00000000..21827d94
--- /dev/null
+++ b/assets/js/a93463cf.2fc3a026.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunk_open_sauced_docs_opensauced_pizza=self.webpackChunk_open_sauced_docs_opensauced_pizza||[]).push([[1958],{8356:(t,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>l,frontMatter:()=>o,metadata:()=>a,toc:()=>c});var e=i(4848),s=i(8453);const o={id:"understanding-contribs-insights",title:"Understanding Contributor Insights Data",sidebar_label:"Understanding Contributor Insights Data",keywords:["maintainers","guides","Contributor Insights Analysis","List Data Exploration","Data Organization","Data Insight from Contributor Insights","List Visualization","Data Representation in Contributor Insights","List Data Interpretation","Organizing Data in Contributor Insights"]},r=void 0,a={id:"maintainers/understanding-contribs-insights",title:"Understanding Contributor Insights Data",description:"Once you've created your Contributor Insight Page, it's time to understand the data provided. Understanding this data is key to effectively managing your projects and contributors.",source:"@site/docs/maintainers/understanding-contrib-insights.md",sourceDirName:"maintainers",slug:"/maintainers/understanding-contribs-insights",permalink:"/maintainers/understanding-contribs-insights",draft:!1,unlisted:!1,editUrl:"https://github.com/open-sauced/docs.opensauced.pizza/edit/main/docs/maintainers/understanding-contrib-insights.md",tags:[],version:"current",lastUpdatedBy:"BekahHW",lastUpdatedAt:1717170876e3,frontMatter:{id:"understanding-contribs-insights",title:"Understanding Contributor Insights Data",sidebar_label:"Understanding Contributor Insights Data",keywords:["maintainers","guides","Contributor Insights Analysis","List Data Exploration","Data Organization","Data Insight from Contributor Insights","List Visualization","Data Representation in Contributor Insights","List Data Interpretation","Organizing Data in Contributor Insights"]},sidebar:"docs",previous:{title:"Understanding Repo Insights Data",permalink:"/maintainers/understanding-repo-insights"},next:{title:"Contributors Guide to OpenSauced",permalink:"/contributors/contributors-guide-to-open-sauced"}},d={},c=[{value:"Understanding Contributor Insights Data",id:"understanding-contributor-insights-data",level:2},{value:"Interpreting Total Commits in the Last 30 Days",id:"interpreting-total-commits-in-the-last-30-days",level:3},{value:"Monitoring Active Contributors",id:"monitoring-active-contributors",level:3},{value:"Understanding Types of Contributors",id:"understanding-types-of-contributors",level:3},{value:"New Contributors",id:"new-contributors",level:4},{value:"Alumni Contributors",id:"alumni-contributors",level:4},{value:"Most Active Contributors",id:"most-active-contributors",level:4},{value:"Activity Across Other Repositories",id:"activity-across-other-repositories",level:3}];function u(t){const n={h2:"h2",h3:"h3",h4:"h4",p:"p",...(0,s.R)(),...t.components};return(0,e.jsxs)(e.Fragment,{children:[(0,e.jsx)(n.p,{children:"Once you've created your Contributor Insight Page, it's time to understand the data provided. Understanding this data is key to effectively managing your projects and contributors."}),"\n",(0,e.jsx)(n.h2,{id:"understanding-contributor-insights-data",children:"Understanding Contributor Insights Data"}),"\n",(0,e.jsx)(n.h3,{id:"interpreting-total-commits-in-the-last-30-days",children:"Interpreting Total Commits in the Last 30 Days"}),"\n",(0,e.jsx)(n.p,{children:"Understanding the commits over the last 30 days helps in gauging the overall activity and productivity of the group."}),"\n",(0,e.jsx)(n.p,{children:"High commit volume might indicate a highly active and engaged team. A sudden drop could signal potential issues or a need for additional support or motivation."}),"\n",(0,e.jsx)(n.h3,{id:"monitoring-active-contributors",children:"Monitoring Active Contributors"}),"\n",(0,e.jsx)(n.p,{children:"Identifying active contributors helps in recognizing reliable team members and planning future tasks."}),"\n",(0,e.jsx)(n.p,{children:"Trends in active contributor numbers can indicate the health of the project community and the effectiveness of engagement strategies. Notice the ebbs and flows in individual contributors\u2019 activity."}),"\n",(0,e.jsx)(n.p,{children:"A decline in a normally active contributor\u2019s engagement could indicate burnout or dissatisfaction, while a surge in activity might be tied to recent changes or enhancements in the project. Tracking activity levels can help you manage team burnout, understand resource needs, and spot potential issues before they escalate."}),"\n",(0,e.jsx)(n.h3,{id:"understanding-types-of-contributors",children:"Understanding Types of Contributors"}),"\n",(0,e.jsx)(n.h4,{id:"new-contributors",children:"New Contributors"}),"\n",(0,e.jsx)(n.p,{children:"Tracking new contributors is key to understanding the growth and influx of new talent."}),"\n",(0,e.jsx)(n.p,{children:"An influx of new contributors might be a positive sign of project popularity, successful outreach efforts, or the community health of your project. However, it could also indicate a need for more support and guidance for new contributors."}),"\n",(0,e.jsx)(n.h4,{id:"alumni-contributors",children:"Alumni Contributors"}),"\n",(0,e.jsx)(n.p,{children:"Alumni contributors are contributors who haven't been active in the last 30 days. Identifying contributors who have stopped contributing helps in assessing potential issues or dissatisfaction."}),"\n",(0,e.jsx)(n.p,{children:"High churn rates could signal deeper problems within the project environment or community management."}),"\n",(0,e.jsx)(n.h4,{id:"most-active-contributors",children:"Most Active Contributors"}),"\n",(0,e.jsx)(n.p,{children:"Identifying key contributors and potential leaders is important for project health and growth. It can help with delegation of responsibilities and recognition of top performers. It can also identify potential mentors for new contributors and help in planning for succession."}),"\n",(0,e.jsx)(n.p,{children:"If you see that a few active contributors are doing most of the work, it might be a sign that the project needs more support or that the workload needs to be better distributed."}),"\n",(0,e.jsx)(n.h3,{id:"activity-across-other-repositories",children:"Activity Across Other Repositories"}),"\n",(0,e.jsx)(n.p,{children:"Understanding the range of repositories to which contributors in a list have recently contributed shows the broader interests and skills of the community. It reveals contributors' engagement levels and potential specializations, which allows for effective task allocation and identifying mentorship or leadership candidates."}),"\n",(0,e.jsx)(n.p,{children:"Additionally, it opens paths for potential cross-project collaborations and strategic project planning, aligning the project\u2019s goals with trends and interests in the open source ecosystem."}),"\n",(0,e.jsx)(n.p,{children:"Understanding the recent history of each contributor's engagement assists in tracking individual contribution patterns and identifying potentially cooling interests."})]})}function l(t={}){const{wrapper:n}={...(0,s.R)(),...t.components};return n?(0,e.jsx)(n,{...t,children:(0,e.jsx)(u,{...t})}):u(t)}},8453:(t,n,i)=>{i.d(n,{R:()=>r,x:()=>a});var e=i(6540);const s={},o=e.createContext(s);function r(t){const n=e.useContext(o);return e.useMemo((function(){return"function"==typeof t?t(n):{...n,...t}}),[n,t])}function a(t){let n;return n=t.disableParentContext?"function"==typeof t.components?t.components(s):t.components||s:r(t.components),e.createElement(o.Provider,{value:n},t.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/ac97b6b0.f272f777.js b/assets/js/ac97b6b0.f272f777.js
new file mode 100644
index 00000000..507c18b1
--- /dev/null
+++ b/assets/js/ac97b6b0.f272f777.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunk_open_sauced_docs_opensauced_pizza=self.webpackChunk_open_sauced_docs_opensauced_pizza||[]).push([[3925],{1737:(n,e,o)=>{o.r(e),o.d(e,{assets:()=>a,contentTitle:()=>s,default:()=>l,frontMatter:()=>c,metadata:()=>r,toc:()=>d});var t=o(4848),i=o(8453);const c={id:"connections",title:"Grow Your Network with Our Connections Feature!",sidebar_label:"Connections",keywords:["connections","Network connections","Professional connections","Building connections","Online connections","Networking opportunities","tech connections","grow network","grow connection","Community connections"]},s=void 0,r={id:"features/connections",title:"Grow Your Network with Our Connections Feature!",description:"What are Connections?",source:"@site/docs/features/connections.md",sourceDirName:"features",slug:"/features/connections",permalink:"/features/connections",draft:!1,unlisted:!1,editUrl:"https://github.com/open-sauced/docs.opensauced.pizza/edit/main/docs/features/connections.md",tags:[],version:"current",lastUpdatedBy:"BekahHW",lastUpdatedAt:1717170876e3,frontMatter:{id:"connections",title:"Grow Your Network with Our Connections Feature!",sidebar_label:"Connections",keywords:["connections","Network connections","Professional connections","Building connections","Online connections","Networking opportunities","tech connections","grow network","grow connection","Community connections"]}},a={},d=[{value:"What are Connections?",id:"what-are-connections",level:2},{value:"How do Connections Work?",id:"how-do-connections-work",level:2}];function u(n){const e={a:"a",h2:"h2",img:"img",li:"li",p:"p",strong:"strong",ul:"ul",...(0,i.R)(),...n.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(e.h2,{id:"what-are-connections",children:"What are Connections?"}),"\n",(0,t.jsxs)(e.p,{children:["Connections on OpenSauced serve as a way to build and nurture your professional network within the open source ecosystem. Imagine you're searching for experts in Artificial Intelligence using our ",(0,t.jsx)(e.a,{href:"/features/contributor-insights",children:"Contributor Insights"})," feature, and you come across several promising developers. What's next?"]}),"\n",(0,t.jsx)(e.p,{children:"With Connections, you can now send a request to connect, bringing these experts into your professional circle for easy communication and collaboration."}),"\n",(0,t.jsx)(e.p,{children:(0,t.jsx)(e.img,{alt:"connections demo",src:o(1682).A+"",width:"3064",height:"2016"})}),"\n",(0,t.jsx)(e.h2,{id:"how-do-connections-work",children:"How do Connections Work?"}),"\n",(0,t.jsxs)(e.ul,{children:["\n",(0,t.jsxs)(e.li,{children:[(0,t.jsx)(e.strong,{children:"Sending connection requests"}),": Once you identify users you'd like to connect with, you can send them a connection request."]}),"\n",(0,t.jsxs)(e.li,{children:[(0,t.jsx)(e.strong,{children:"Acceptance"}),": Upon acceptance of your connection request, both parties become 1st-degree connections."]}),"\n",(0,t.jsxs)(e.li,{children:[(0,t.jsx)(e.strong,{children:"Following highlights"}),": After becoming 1st-degree connections, you can follow each other's highlights, keeping up-to-date with accomplishments, contributions, and other notable activities."]}),"\n",(0,t.jsxs)(e.li,{children:[(0,t.jsx)(e.strong,{children:"Contact information"}),": Post-acceptance, you'll have access to contact information to foster direct communication and ongoing dialogue."]}),"\n"]}),"\n",(0,t.jsxs)(e.p,{children:["Are you interested? Navigate to ",(0,t.jsx)(e.a,{href:"https://opensauced.pizza/",children:"OpenSauced"}),", create your Pro account, and start building!"]})]})}function l(n={}){const{wrapper:e}={...(0,i.R)(),...n.components};return e?(0,t.jsx)(e,{...n,children:(0,t.jsx)(u,{...n})}):u(n)}},1682:(n,e,o)=>{o.d(e,{A:()=>t});const t=o.p+"assets/images/connections-fdbdf5ac9efdf36b2a8453bd48708302.gif"},8453:(n,e,o)=>{o.d(e,{R:()=>s,x:()=>r});var t=o(6540);const i={},c=t.createContext(i);function s(n){const e=t.useContext(c);return t.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function r(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(i):n.components||i:s(n.components),t.createElement(c.Provider,{value:e},n.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/ac97b6b0.f57833ab.js b/assets/js/ac97b6b0.f57833ab.js
deleted file mode 100644
index 47353d8f..00000000
--- a/assets/js/ac97b6b0.f57833ab.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunk_open_sauced_docs_opensauced_pizza=self.webpackChunk_open_sauced_docs_opensauced_pizza||[]).push([[3925],{1737:(n,e,o)=>{o.r(e),o.d(e,{assets:()=>a,contentTitle:()=>s,default:()=>l,frontMatter:()=>c,metadata:()=>r,toc:()=>d});var t=o(4848),i=o(8453);const c={id:"connections",title:"Grow Your Network with Our Connections Feature!",sidebar_label:"Connections",keywords:["connections","Network connections","Professional connections","Building connections","Online connections","Networking opportunities","tech connections","grow network","grow connection","Community connections"]},s=void 0,r={id:"features/connections",title:"Grow Your Network with Our Connections Feature!",description:"What are Connections?",source:"@site/docs/features/connections.md",sourceDirName:"features",slug:"/features/connections",permalink:"/features/connections",draft:!1,unlisted:!1,editUrl:"https://github.com/open-sauced/docs.opensauced.pizza/edit/main/docs/features/connections.md",tags:[],version:"current",lastUpdatedBy:"BekahHW",lastUpdatedAt:171701191e4,frontMatter:{id:"connections",title:"Grow Your Network with Our Connections Feature!",sidebar_label:"Connections",keywords:["connections","Network connections","Professional connections","Building connections","Online connections","Networking opportunities","tech connections","grow network","grow connection","Community connections"]}},a={},d=[{value:"What are Connections?",id:"what-are-connections",level:2},{value:"How do Connections Work?",id:"how-do-connections-work",level:2}];function u(n){const e={a:"a",h2:"h2",img:"img",li:"li",p:"p",strong:"strong",ul:"ul",...(0,i.R)(),...n.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(e.h2,{id:"what-are-connections",children:"What are Connections?"}),"\n",(0,t.jsxs)(e.p,{children:["Connections on OpenSauced serve as a way to build and nurture your professional network within the open source ecosystem. Imagine you're searching for experts in Artificial Intelligence using our ",(0,t.jsx)(e.a,{href:"/features/contributor-insights",children:"Contributor Insights"})," feature, and you come across several promising developers. What's next?"]}),"\n",(0,t.jsx)(e.p,{children:"With Connections, you can now send a request to connect, bringing these experts into your professional circle for easy communication and collaboration."}),"\n",(0,t.jsx)(e.p,{children:(0,t.jsx)(e.img,{alt:"connections demo",src:o(1682).A+"",width:"3064",height:"2016"})}),"\n",(0,t.jsx)(e.h2,{id:"how-do-connections-work",children:"How do Connections Work?"}),"\n",(0,t.jsxs)(e.ul,{children:["\n",(0,t.jsxs)(e.li,{children:[(0,t.jsx)(e.strong,{children:"Sending connection requests"}),": Once you identify users you'd like to connect with, you can send them a connection request."]}),"\n",(0,t.jsxs)(e.li,{children:[(0,t.jsx)(e.strong,{children:"Acceptance"}),": Upon acceptance of your connection request, both parties become 1st-degree connections."]}),"\n",(0,t.jsxs)(e.li,{children:[(0,t.jsx)(e.strong,{children:"Following highlights"}),": After becoming 1st-degree connections, you can follow each other's highlights, keeping up-to-date with accomplishments, contributions, and other notable activities."]}),"\n",(0,t.jsxs)(e.li,{children:[(0,t.jsx)(e.strong,{children:"Contact information"}),": Post-acceptance, you'll have access to contact information to foster direct communication and ongoing dialogue."]}),"\n"]}),"\n",(0,t.jsxs)(e.p,{children:["Are you interested? Navigate to ",(0,t.jsx)(e.a,{href:"https://opensauced.pizza/",children:"OpenSauced"}),", create your Pro account, and start building!"]})]})}function l(n={}){const{wrapper:e}={...(0,i.R)(),...n.components};return e?(0,t.jsx)(e,{...n,children:(0,t.jsx)(u,{...n})}):u(n)}},1682:(n,e,o)=>{o.d(e,{A:()=>t});const t=o.p+"assets/images/connections-fdbdf5ac9efdf36b2a8453bd48708302.gif"},8453:(n,e,o)=>{o.d(e,{R:()=>s,x:()=>r});var t=o(6540);const i={},c=t.createContext(i);function s(n){const e=t.useContext(c);return t.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function r(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(i):n.components||i:s(n.components),t.createElement(c.Provider,{value:e},n.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/aef95fb0.3526ea7a.js b/assets/js/aef95fb0.3526ea7a.js
deleted file mode 100644
index 15fd498e..00000000
--- a/assets/js/aef95fb0.3526ea7a.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunk_open_sauced_docs_opensauced_pizza=self.webpackChunk_open_sauced_docs_opensauced_pizza||[]).push([[8785],{2863:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>s,default:()=>l,frontMatter:()=>a,metadata:()=>o,toc:()=>c});var t=i(4848),r=i(8453);const a={id:"understanding-repo-insights",title:"Understanding Repo Insights Data",sidebar_label:"Understanding Repo Insights Data",keywords:["maintainers","guides","Insights Interpretation","Analytical Understanding","Insights Overview","Maintainer Insights","Guide to Data Understanding","Data Interpretation Methods","Insightful Data Examination","Guide to Understanding Data"]},s=void 0,o={id:"maintainers/understanding-repo-insights",title:"Understanding Repo Insights Data",description:"Once your repositories are connected, it's time to understand the data provided on your page. Understanding this data is key to effectively managing your projects and contributors.",source:"@site/docs/maintainers/understanding-repo-insights.md",sourceDirName:"maintainers",slug:"/maintainers/understanding-repo-insights",permalink:"/maintainers/understanding-repo-insights",draft:!1,unlisted:!1,editUrl:"https://github.com/open-sauced/docs.opensauced.pizza/edit/main/docs/maintainers/understanding-repo-insights.md",tags:[],version:"current",lastUpdatedBy:"BekahHW",lastUpdatedAt:171701191e4,frontMatter:{id:"understanding-repo-insights",title:"Understanding Repo Insights Data",sidebar_label:"Understanding Repo Insights Data",keywords:["maintainers","guides","Insights Interpretation","Analytical Understanding","Insights Overview","Maintainer Insights","Guide to Data Understanding","Data Interpretation Methods","Insightful Data Examination","Guide to Understanding Data"]},sidebar:"docs",previous:{title:"Maintainers Guide to OpenSauced",permalink:"/maintainers/maintainers-guide-to-open-sauced"},next:{title:"Understanding Contributor Insights Data",permalink:"/maintainers/understanding-contribs-insights"}},d={},c=[{value:"Understanding Repository Insights Data",id:"understanding-repository-insights-data",level:2},{value:"Analyzing Contribution Trends",id:"analyzing-contribution-trends",level:3},{value:"Monitoring PR Activity",id:"monitoring-pr-activity",level:3},{value:"Measuring and Improving PR Velocity",id:"measuring-and-improving-pr-velocity",level:3},{value:"Understanding Repository Insights Contributor Data",id:"understanding-repository-insights-contributor-data",level:2},{value:"Identifying and Engaging with Key Contributors",id:"identifying-and-engaging-with-key-contributors",level:3},{value:"Tracking and Responding to Contributor Activity Levels",id:"tracking-and-responding-to-contributor-activity-levels",level:3},{value:"Activity Levels Across Repositories",id:"activity-levels-across-repositories",level:3},{value:"Understanding Activity Levels Over Time",id:"understanding-activity-levels-over-time",level:3},{value:"Using Programming Language Data",id:"using-programming-language-data",level:3},{value:"Creating Opportunities",id:"creating-opportunities",level:3}];function g(e){const n={h2:"h2",h3:"h3",p:"p",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.p,{children:"Once your repositories are connected, it's time to understand the data provided on your page. Understanding this data is key to effectively managing your projects and contributors."}),"\n",(0,t.jsx)(n.h2,{id:"understanding-repository-insights-data",children:"Understanding Repository Insights Data"}),"\n",(0,t.jsx)(n.h3,{id:"analyzing-contribution-trends",children:"Analyzing Contribution Trends"}),"\n",(0,t.jsx)(n.p,{children:"Discover patterns in contributions over time. Look for spikes or drops in activity and correlate these with specific events or milestones. This can help you understand what drives engagement in your projects."}),"\n",(0,t.jsx)(n.h3,{id:"monitoring-pr-activity",children:"Monitoring PR Activity"}),"\n",(0,t.jsx)(n.p,{children:"Knowing the status of PRs (open, closed, draft, merged) helps in understanding the workflow efficiency and backlog. High volumes of open or draft PRs might indicate a need for more resources or a revision of your review process. Conversely, a steady flow of merged PRs can indicate a healthy, active development process."}),"\n",(0,t.jsx)(n.h3,{id:"measuring-and-improving-pr-velocity",children:"Measuring and Improving PR Velocity"}),"\n",(0,t.jsx)(n.p,{children:"Track how quickly PRs are being merged. The average time taken for PRs to merge is a critical metric for understanding the efficiency of the code review and deployment process. Longer PR merge times might signal issues in the review process or resource allocation or could indicate complex code changes that require more thorough checks. Use this data to set benchmarks and identify opportunities for streamlining your review and integration processes."}),"\n",(0,t.jsx)(n.h2,{id:"understanding-repository-insights-contributor-data",children:"Understanding Repository Insights Contributor Data"}),"\n",(0,t.jsx)(n.h3,{id:"identifying-and-engaging-with-key-contributors",children:"Identifying and Engaging with Key Contributors"}),"\n",(0,t.jsx)(n.p,{children:"Recognizing key contributors helps in understanding the project's most active and influential members. Consider reaching out to them for deeper collaboration or acknowledging their efforts to keep them motivated and engaged."}),"\n",(0,t.jsx)(n.h3,{id:"tracking-and-responding-to-contributor-activity-levels",children:"Tracking and Responding to Contributor Activity Levels"}),"\n",(0,t.jsx)(n.p,{children:"Tracking how active contributors are and the trends in their activity levels is crucial for project health. Understanding the activity patterns of contributors helps in assessing their engagement and reliability. Regular contributors are often more familiar with the project and can be more dependable for critical tasks."}),"\n",(0,t.jsx)(n.p,{children:"Notice the ebbs and flows in individual contributors\u2019 activity. A decline in a normally active contributor\u2019s engagement could indicate burnout or dissatisfaction, while a surge in activity might be tied to recent changes or enhancements in the project. Tracking activity levels can help you manage team burnout, understand resource needs, and spot potential issues before they escalate."}),"\n",(0,t.jsx)(n.h3,{id:"activity-levels-across-repositories",children:"Activity Levels Across Repositories"}),"\n",(0,t.jsx)(n.p,{children:"This indicates the breadth of a contributor's involvement in open source projects. A contributor active across multiple repositories might bring diverse experiences and ideas but may also have divided attention. Alternatively, a contributor active in a single repository might be more focused and familiar with the project."}),"\n",(0,t.jsx)(n.h3,{id:"understanding-activity-levels-over-time",children:"Understanding Activity Levels Over Time"}),"\n",(0,t.jsx)(n.p,{children:"Past activity levels can be a predictor of future contributions. Regular past contributions might suggest continued involvement. However, a contributor who has been inactive for a while might be less likely to contribute in the future."}),"\n",(0,t.jsx)(n.p,{children:"Trends in activity levels and contributions can be indicators of the overall health of the project community. A decline in activity might signal issues that need addressing to keep the community vibrant and engaged."}),"\n",(0,t.jsx)(n.h3,{id:"using-programming-language-data",children:"Using Programming Language Data"}),"\n",(0,t.jsx)(n.p,{children:"Awareness of the programming languages a contributor is comfortable with enables maintainers to assign tasks more effectively, ensuring that contributors work in areas where they are most skilled and interested. This can help in identifying contributors for specific tasks or projects."}),"\n",(0,t.jsx)(n.h3,{id:"creating-opportunities",children:"Creating Opportunities"}),"\n",(0,t.jsx)(n.p,{children:"Understanding who contributes to what open source projects and when they do can help maintainers manage team dynamics. With this information, maintainers can make decisions to ensure workloads are balanced and contributors are working in areas that match their skills and interests. Identifying less experienced contributors who are active and showing potential can lead to mentorship opportunities, helping to grow the project\u2019s contributor base."})]})}function l(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(g,{...e})}):g(e)}},8453:(e,n,i)=>{i.d(n,{R:()=>s,x:()=>o});var t=i(6540);const r={},a=t.createContext(r);function s(e){const n=t.useContext(a);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:s(e.components),t.createElement(a.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/aef95fb0.c29f5fa0.js b/assets/js/aef95fb0.c29f5fa0.js
new file mode 100644
index 00000000..fc837b57
--- /dev/null
+++ b/assets/js/aef95fb0.c29f5fa0.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunk_open_sauced_docs_opensauced_pizza=self.webpackChunk_open_sauced_docs_opensauced_pizza||[]).push([[8785],{2863:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>s,default:()=>l,frontMatter:()=>a,metadata:()=>o,toc:()=>c});var t=i(4848),r=i(8453);const a={id:"understanding-repo-insights",title:"Understanding Repo Insights Data",sidebar_label:"Understanding Repo Insights Data",keywords:["maintainers","guides","Insights Interpretation","Analytical Understanding","Insights Overview","Maintainer Insights","Guide to Data Understanding","Data Interpretation Methods","Insightful Data Examination","Guide to Understanding Data"]},s=void 0,o={id:"maintainers/understanding-repo-insights",title:"Understanding Repo Insights Data",description:"Once your repositories are connected, it's time to understand the data provided on your page. Understanding this data is key to effectively managing your projects and contributors.",source:"@site/docs/maintainers/understanding-repo-insights.md",sourceDirName:"maintainers",slug:"/maintainers/understanding-repo-insights",permalink:"/maintainers/understanding-repo-insights",draft:!1,unlisted:!1,editUrl:"https://github.com/open-sauced/docs.opensauced.pizza/edit/main/docs/maintainers/understanding-repo-insights.md",tags:[],version:"current",lastUpdatedBy:"BekahHW",lastUpdatedAt:1717170876e3,frontMatter:{id:"understanding-repo-insights",title:"Understanding Repo Insights Data",sidebar_label:"Understanding Repo Insights Data",keywords:["maintainers","guides","Insights Interpretation","Analytical Understanding","Insights Overview","Maintainer Insights","Guide to Data Understanding","Data Interpretation Methods","Insightful Data Examination","Guide to Understanding Data"]},sidebar:"docs",previous:{title:"Maintainers Guide to OpenSauced",permalink:"/maintainers/maintainers-guide-to-open-sauced"},next:{title:"Understanding Contributor Insights Data",permalink:"/maintainers/understanding-contribs-insights"}},d={},c=[{value:"Understanding Repository Insights Data",id:"understanding-repository-insights-data",level:2},{value:"Analyzing Contribution Trends",id:"analyzing-contribution-trends",level:3},{value:"Monitoring PR Activity",id:"monitoring-pr-activity",level:3},{value:"Measuring and Improving PR Velocity",id:"measuring-and-improving-pr-velocity",level:3},{value:"Understanding Repository Insights Contributor Data",id:"understanding-repository-insights-contributor-data",level:2},{value:"Identifying and Engaging with Key Contributors",id:"identifying-and-engaging-with-key-contributors",level:3},{value:"Tracking and Responding to Contributor Activity Levels",id:"tracking-and-responding-to-contributor-activity-levels",level:3},{value:"Activity Levels Across Repositories",id:"activity-levels-across-repositories",level:3},{value:"Understanding Activity Levels Over Time",id:"understanding-activity-levels-over-time",level:3},{value:"Using Programming Language Data",id:"using-programming-language-data",level:3},{value:"Creating Opportunities",id:"creating-opportunities",level:3}];function g(e){const n={h2:"h2",h3:"h3",p:"p",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.p,{children:"Once your repositories are connected, it's time to understand the data provided on your page. Understanding this data is key to effectively managing your projects and contributors."}),"\n",(0,t.jsx)(n.h2,{id:"understanding-repository-insights-data",children:"Understanding Repository Insights Data"}),"\n",(0,t.jsx)(n.h3,{id:"analyzing-contribution-trends",children:"Analyzing Contribution Trends"}),"\n",(0,t.jsx)(n.p,{children:"Discover patterns in contributions over time. Look for spikes or drops in activity and correlate these with specific events or milestones. This can help you understand what drives engagement in your projects."}),"\n",(0,t.jsx)(n.h3,{id:"monitoring-pr-activity",children:"Monitoring PR Activity"}),"\n",(0,t.jsx)(n.p,{children:"Knowing the status of PRs (open, closed, draft, merged) helps in understanding the workflow efficiency and backlog. High volumes of open or draft PRs might indicate a need for more resources or a revision of your review process. Conversely, a steady flow of merged PRs can indicate a healthy, active development process."}),"\n",(0,t.jsx)(n.h3,{id:"measuring-and-improving-pr-velocity",children:"Measuring and Improving PR Velocity"}),"\n",(0,t.jsx)(n.p,{children:"Track how quickly PRs are being merged. The average time taken for PRs to merge is a critical metric for understanding the efficiency of the code review and deployment process. Longer PR merge times might signal issues in the review process or resource allocation or could indicate complex code changes that require more thorough checks. Use this data to set benchmarks and identify opportunities for streamlining your review and integration processes."}),"\n",(0,t.jsx)(n.h2,{id:"understanding-repository-insights-contributor-data",children:"Understanding Repository Insights Contributor Data"}),"\n",(0,t.jsx)(n.h3,{id:"identifying-and-engaging-with-key-contributors",children:"Identifying and Engaging with Key Contributors"}),"\n",(0,t.jsx)(n.p,{children:"Recognizing key contributors helps in understanding the project's most active and influential members. Consider reaching out to them for deeper collaboration or acknowledging their efforts to keep them motivated and engaged."}),"\n",(0,t.jsx)(n.h3,{id:"tracking-and-responding-to-contributor-activity-levels",children:"Tracking and Responding to Contributor Activity Levels"}),"\n",(0,t.jsx)(n.p,{children:"Tracking how active contributors are and the trends in their activity levels is crucial for project health. Understanding the activity patterns of contributors helps in assessing their engagement and reliability. Regular contributors are often more familiar with the project and can be more dependable for critical tasks."}),"\n",(0,t.jsx)(n.p,{children:"Notice the ebbs and flows in individual contributors\u2019 activity. A decline in a normally active contributor\u2019s engagement could indicate burnout or dissatisfaction, while a surge in activity might be tied to recent changes or enhancements in the project. Tracking activity levels can help you manage team burnout, understand resource needs, and spot potential issues before they escalate."}),"\n",(0,t.jsx)(n.h3,{id:"activity-levels-across-repositories",children:"Activity Levels Across Repositories"}),"\n",(0,t.jsx)(n.p,{children:"This indicates the breadth of a contributor's involvement in open source projects. A contributor active across multiple repositories might bring diverse experiences and ideas but may also have divided attention. Alternatively, a contributor active in a single repository might be more focused and familiar with the project."}),"\n",(0,t.jsx)(n.h3,{id:"understanding-activity-levels-over-time",children:"Understanding Activity Levels Over Time"}),"\n",(0,t.jsx)(n.p,{children:"Past activity levels can be a predictor of future contributions. Regular past contributions might suggest continued involvement. However, a contributor who has been inactive for a while might be less likely to contribute in the future."}),"\n",(0,t.jsx)(n.p,{children:"Trends in activity levels and contributions can be indicators of the overall health of the project community. A decline in activity might signal issues that need addressing to keep the community vibrant and engaged."}),"\n",(0,t.jsx)(n.h3,{id:"using-programming-language-data",children:"Using Programming Language Data"}),"\n",(0,t.jsx)(n.p,{children:"Awareness of the programming languages a contributor is comfortable with enables maintainers to assign tasks more effectively, ensuring that contributors work in areas where they are most skilled and interested. This can help in identifying contributors for specific tasks or projects."}),"\n",(0,t.jsx)(n.h3,{id:"creating-opportunities",children:"Creating Opportunities"}),"\n",(0,t.jsx)(n.p,{children:"Understanding who contributes to what open source projects and when they do can help maintainers manage team dynamics. With this information, maintainers can make decisions to ensure workloads are balanced and contributors are working in areas that match their skills and interests. Identifying less experienced contributors who are active and showing potential can lead to mentorship opportunities, helping to grow the project\u2019s contributor base."})]})}function l(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(g,{...e})}):g(e)}},8453:(e,n,i)=>{i.d(n,{R:()=>s,x:()=>o});var t=i(6540);const r={},a=t.createContext(r);function s(e){const n=t.useContext(a);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:s(e.components),t.createElement(a.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/b44b9bb7.549b3922.js b/assets/js/b44b9bb7.549b3922.js
new file mode 100644
index 00000000..81f24cb3
--- /dev/null
+++ b/assets/js/b44b9bb7.549b3922.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunk_open_sauced_docs_opensauced_pizza=self.webpackChunk_open_sauced_docs_opensauced_pizza||[]).push([[4959],{7239:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>l,contentTitle:()=>a,default:()=>h,frontMatter:()=>o,metadata:()=>r,toc:()=>c});var s=i(4848),t=i(8453);const o={id:"pizza-cli",title:"Introduction to the Pizza CLI",sidebar_label:"Pizza CLI",keywords:["introduction to the pizza cli","Pizza CLI Overview","Command Line Interface Introduction","CLI Basics","Pizza Command Line Tool","CLI Usage Guide","Pizza CLI Commands","Introduction to Command-Line Interfaces","Command Line Tool Features","CLI for Pizza Enthusiasts","Pizza Ordering CLI","Getting Started with Pizza CLI"]},a=void 0,r={id:"tools/pizza-cli",title:"Introduction to the Pizza CLI",description:"The OpenSauced Pizza CLI",source:"@site/docs/tools/pizza-cli.md",sourceDirName:"tools",slug:"/tools/pizza-cli",permalink:"/tools/pizza-cli",draft:!1,unlisted:!1,editUrl:"https://github.com/open-sauced/docs.opensauced.pizza/edit/main/docs/tools/pizza-cli.md",tags:[],version:"current",lastUpdatedBy:"BekahHW",lastUpdatedAt:1717170876e3,frontMatter:{id:"pizza-cli",title:"Introduction to the Pizza CLI",sidebar_label:"Pizza CLI",keywords:["introduction to the pizza cli","Pizza CLI Overview","Command Line Interface Introduction","CLI Basics","Pizza Command Line Tool","CLI Usage Guide","Pizza CLI Commands","Introduction to Command-Line Interfaces","Command Line Tool Features","CLI for Pizza Enthusiasts","Pizza Ordering CLI","Getting Started with Pizza CLI"]},sidebar:"docs",previous:{title:"Hot OpenSauced Project",permalink:"/tools/hot-opensauced"},next:{title:"Introduction to the Chrome Extension",permalink:"/tools/chrome-extension/introduction-to-the-chrome-extension"}},l={},c=[{value:"The OpenSauced Pizza CLI",id:"the-opensauced-pizza-cli",level:2},{value:"Key Features",id:"key-features",level:2},{value:"Installation and Instructions",id:"installation-and-instructions",level:2},{value:"\ud83d\udce6 Download and Install",id:"-download-and-install",level:3},{value:"\ud83d\udda5\ufe0f Local Development Setup",id:"\ufe0f-local-development-setup",level:3}];function d(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h2,{id:"the-opensauced-pizza-cli",children:"The OpenSauced Pizza CLI"}),"\n",(0,s.jsx)(n.p,{children:"The OpenSauced Pizza CLI is a command-line utility designed specifically for OpenSauced. It provides a comprehensive set of functionalities that make it easier for users to gain insights and metrics and manage various tasks related to open source projects through OpenSauced."}),"\n",(0,s.jsx)(n.p,{children:"Beyond just code commits, the pizza CLI reports on different ways individuals contribute to the open source ecosystem through community engagement, issue reporting, blog post writings, or pull request creations."}),"\n",(0,s.jsx)(n.h2,{id:"key-features",children:"Key Features"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"Bake"}),": Seamlessly source git commits into OpenSauced with the metaphorical 'oven' of technology."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"Insights"}),": Dive deep into data about git contributors, repositories, users, and pull requests."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"Repo-query"}),": Get your questions about any GitHub repository answered."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"Show"}),": Visualize the metrics of a repository, providing a holistic view of its health and activity."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"Login"}),": Securely log into the application via GitHub, ensuring a streamlined and safe experience."]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"installation-and-instructions",children:"Installation and Instructions"}),"\n",(0,s.jsx)(n.h3,{id:"-download-and-install",children:"\ud83d\udce6 Download and Install"}),"\n",(0,s.jsx)(n.p,{children:"The pizza CLI provides multiple installation methods to cater to the varied preferences of its users:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Homebrew"}),": For macOS users who prefer the Homebrew package manager."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"brew install open-sauced/tap/pizza\n"})}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"NPM"}),": For those who are fond of the Node Package Manager."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"npm i -g pizza\n"})}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Direct script"}),": A quick way to get started by directly fetching the installation script from GitHub."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"curl -fsSL https://raw.githubusercontent.com/open-sauced/pizza-cli/main/install.sh\n"})}),"\n",(0,s.jsxs)(n.p,{children:["\u26a0\ufe0f ",(0,s.jsx)(n.strong,{children:"Warning"}),": Piping scripts directly from the web to your shell can be risky. Always ensure you trust the source. For a safer approach, download, inspect, and then execute the following commands:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"curl -fsSL https://raw.githubusercontent.com/open-sauced/pizza-cli/main/install.sh > install.sh\nvim install.sh\n./install.sh\n"})}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Manual build and install"}),": For those who like a hands-on approach."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"make install\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Ensure ",(0,s.jsx)(n.code,{children:"/usr/local/bin/"})," is in your path with:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:'export PATH="$PATH:/usr/local/bin"\n'})}),"\n",(0,s.jsxs)(n.p,{children:["Alternatively, after building with ",(0,s.jsx)(n.code,{children:"make build"}),", move the binary to your desired location:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"mv build/pizza Your Docusaurus site did not load properly.
\nA very common reason is a wrong site baseUrl configuration.
\nCurrent configured baseUrl = ${e} ${"/"===e?" (default value)":""}
\nWe suggest trying baseUrl =
\n.comment can become .namespace--comment) or replace them with your defined ones (like .editor__comment). You can even add new classes.",owner:"dvkndn",noCSS:!0},"file-highlight":{title:"File Highlight",description:"Fetch external files and highlight them with Prism. Used on the Prism website itself.",noCSS:!0},"show-language":{title:"Show Language",description:"Display the highlighted language in code blocks (inline code does not show the label).",owner:"nauzilus",noCSS:!0,require:"toolbar"},"jsonp-highlight":{title:"JSONP Highlight",description:"Fetch content with JSONP and highlight some interesting content (e.g. GitHub/Gists or Bitbucket API).",noCSS:!0,owner:"nauzilus"},"highlight-keywords":{title:"Highlight Keywords",description:"Adds special CSS classes for each keyword for fine-grained highlighting.",owner:"vkbansal",noCSS:!0},"remove-initial-line-feed":{title:"Remove initial line feed",description:"Removes the initial line feed in code blocks.",owner:"Golmote",noCSS:!0},"inline-color":{title:"Inline color",description:"Adds a small inline preview for colors in style sheets.",require:"css-extras",owner:"RunDevelopment"},previewers:{title:"Previewers",description:"Previewers for angles, colors, gradients, easing and time.",require:"css-extras",owner:"Golmote"},autoloader:{title:"Autoloader",description:"Automatically loads the needed languages to highlight the code blocks.",owner:"Golmote",noCSS:!0},"keep-markup":{title:"Keep Markup",description:"Prevents custom markup from being dropped out during highlighting.",owner:"Golmote",optional:"normalize-whitespace",noCSS:!0},"command-line":{title:"Command Line",description:"Display a command line with a prompt and, optionally, the output/response from the commands.",owner:"chriswells0"},"unescaped-markup":{title:"Unescaped Markup",description:"Write markup without having to escape anything."},"normalize-whitespace":{title:"Normalize Whitespace",description:"Supports multiple operations to normalize whitespace in code blocks.",owner:"zeitgeist87",optional:"unescaped-markup",noCSS:!0},"data-uri-highlight":{title:"Data-URI Highlight",description:"Highlights data-URI contents.",owner:"Golmote",noCSS:!0},toolbar:{title:"Toolbar",description:"Attach a toolbar for plugins to easily register buttons on the top of a code block.",owner:"mAAdhaTTah"},"copy-to-clipboard":{title:"Copy to Clipboard Button",description:"Add a button that copies the code block to the clipboard when clicked.",owner:"mAAdhaTTah",require:"toolbar",noCSS:!0},"download-button":{title:"Download Button",description:"A button in the toolbar of a code block adding a convenient way to download a code file.",owner:"Golmote",require:"toolbar",noCSS:!0},"match-braces":{title:"Match braces",description:"Highlights matching braces.",owner:"RunDevelopment"},"diff-highlight":{title:"Diff Highlight",description:"Highlights the code inside diff blocks.",owner:"RunDevelopment",require:"diff"},"filter-highlight-all":{title:"Filter highlightAll",description:"Filters the elements the highlightAll and highlightAllUnder methods actually highlight.",owner:"RunDevelopment",noCSS:!0},treeview:{title:"Treeview",description:"A language with special styles to highlight file system tree structures.",owner:"Golmote"}}})},8722:(e,t,n)=>{const r=n(6969),o=n(8380),a=new Set;function i(e){void 0===e?e=Object.keys(r.languages).filter((e=>"meta"!=e)):Array.isArray(e)||(e=[e]);const t=[...a,...Object.keys(Prism.languages)];o(r,e,t).load((e=>{if(!(e in r.languages))return void(i.silent||console.warn("Language does not exist: "+e));const t="./prism-"+e;delete n.c[n(3157).resolve(t)],delete Prism.languages[e],n(3157)(t),a.add(e)}))}i.silent=!1,e.exports=i},9700:()=>{!function(e){function t(e,t){return"___"+e.toUpperCase()+t+"___"}Object.defineProperties(e.languages["markup-templating"]={},{buildPlaceholders:{value:function(n,r,o,a){if(n.language===r){var i=n.tokenStack=[];n.code=n.code.replace(o,(function(e){if("function"==typeof a&&!a(e))return e;for(var o,l=i.length;-1!==n.code.indexOf(o=t(r,l));)++l;return i[l]=e,o})),n.grammar=e.languages.markup}}},tokenizePlaceholders:{value:function(n,r){if(n.language===r&&n.tokenStack){n.grammar=e.languages[r];var o=0,a=Object.keys(n.tokenStack);!function i(l){for(var s=0;sYour Docusaurus site did not load properly.
\nA very common reason is a wrong site baseUrl configuration.
\nCurrent configured baseUrl = ${e} ${"/"===e?" (default value)":""}
\nWe suggest trying baseUrl =
\n.comment can become .namespace--comment) or replace them with your defined ones (like .editor__comment). You can even add new classes.",owner:"dvkndn",noCSS:!0},"file-highlight":{title:"File Highlight",description:"Fetch external files and highlight them with Prism. Used on the Prism website itself.",noCSS:!0},"show-language":{title:"Show Language",description:"Display the highlighted language in code blocks (inline code does not show the label).",owner:"nauzilus",noCSS:!0,require:"toolbar"},"jsonp-highlight":{title:"JSONP Highlight",description:"Fetch content with JSONP and highlight some interesting content (e.g. GitHub/Gists or Bitbucket API).",noCSS:!0,owner:"nauzilus"},"highlight-keywords":{title:"Highlight Keywords",description:"Adds special CSS classes for each keyword for fine-grained highlighting.",owner:"vkbansal",noCSS:!0},"remove-initial-line-feed":{title:"Remove initial line feed",description:"Removes the initial line feed in code blocks.",owner:"Golmote",noCSS:!0},"inline-color":{title:"Inline color",description:"Adds a small inline preview for colors in style sheets.",require:"css-extras",owner:"RunDevelopment"},previewers:{title:"Previewers",description:"Previewers for angles, colors, gradients, easing and time.",require:"css-extras",owner:"Golmote"},autoloader:{title:"Autoloader",description:"Automatically loads the needed languages to highlight the code blocks.",owner:"Golmote",noCSS:!0},"keep-markup":{title:"Keep Markup",description:"Prevents custom markup from being dropped out during highlighting.",owner:"Golmote",optional:"normalize-whitespace",noCSS:!0},"command-line":{title:"Command Line",description:"Display a command line with a prompt and, optionally, the output/response from the commands.",owner:"chriswells0"},"unescaped-markup":{title:"Unescaped Markup",description:"Write markup without having to escape anything."},"normalize-whitespace":{title:"Normalize Whitespace",description:"Supports multiple operations to normalize whitespace in code blocks.",owner:"zeitgeist87",optional:"unescaped-markup",noCSS:!0},"data-uri-highlight":{title:"Data-URI Highlight",description:"Highlights data-URI contents.",owner:"Golmote",noCSS:!0},toolbar:{title:"Toolbar",description:"Attach a toolbar for plugins to easily register buttons on the top of a code block.",owner:"mAAdhaTTah"},"copy-to-clipboard":{title:"Copy to Clipboard Button",description:"Add a button that copies the code block to the clipboard when clicked.",owner:"mAAdhaTTah",require:"toolbar",noCSS:!0},"download-button":{title:"Download Button",description:"A button in the toolbar of a code block adding a convenient way to download a code file.",owner:"Golmote",require:"toolbar",noCSS:!0},"match-braces":{title:"Match braces",description:"Highlights matching braces.",owner:"RunDevelopment"},"diff-highlight":{title:"Diff Highlight",description:"Highlights the code inside diff blocks.",owner:"RunDevelopment",require:"diff"},"filter-highlight-all":{title:"Filter highlightAll",description:"Filters the elements the highlightAll and highlightAllUnder methods actually highlight.",owner:"RunDevelopment",noCSS:!0},treeview:{title:"Treeview",description:"A language with special styles to highlight file system tree structures.",owner:"Golmote"}}})},8722:(e,t,n)=>{const r=n(6969),o=n(8380),a=new Set;function i(e){void 0===e?e=Object.keys(r.languages).filter((e=>"meta"!=e)):Array.isArray(e)||(e=[e]);const t=[...a,...Object.keys(Prism.languages)];o(r,e,t).load((e=>{if(!(e in r.languages))return void(i.silent||console.warn("Language does not exist: "+e));const t="./prism-"+e;delete n.c[n(3157).resolve(t)],delete Prism.languages[e],n(3157)(t),a.add(e)}))}i.silent=!1,e.exports=i},9700:()=>{!function(e){function t(e,t){return"___"+e.toUpperCase()+t+"___"}Object.defineProperties(e.languages["markup-templating"]={},{buildPlaceholders:{value:function(n,r,o,a){if(n.language===r){var i=n.tokenStack=[];n.code=n.code.replace(o,(function(e){if("function"==typeof a&&!a(e))return e;for(var o,l=i.length;-1!==n.code.indexOf(o=t(r,l));)++l;return i[l]=e,o})),n.grammar=e.languages.markup}}},tokenizePlaceholders:{value:function(n,r){if(n.language===r&&n.tokenStack){n.grammar=e.languages[r];var o=0,a=Object.keys(n.tokenStack);!function i(l){for(var s=0;s