Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
73 lines (52 loc) · 3.74 KB

CONTRIBUTING.md

File metadata and controls

73 lines (52 loc) · 3.74 KB
Raw

Contributing to aspire.dev

Thank you for your interest in contributing to the aspire.dev! This guide will help you get started with local development and contributing to the project.

Visit our contributor guide

Please see the full Contributor guide for detailed instructions on how to contribute to aspire.dev, including guidelines for submitting issues, making pull requests, and coding standards.

Help translate the docs

We welcome translation contributions! Please see our Translation guide to learn how to help translate aspire.dev into other languages. You can check the translation status dashboard to see what needs to be translated or updated.

🏗️ Project structure

└───📂 frontend                   # Astro + Starlight documentation site
   ├───📂 src
   │    ├───📂 components         # Reusable Astro components
   │    ├───📂 content
   │    │    ├───📂 docs          # Markdown / MDX documentation pages
   │    │    └───📂 i18n          # Component translation locales
   │    ├───📂 data               # JSON integration & metadata
   │    ├───📂 styles             # Global & theme CSS
   │    └───📂 assets             # Images, videos, media
   ├───📂 scripts                 # Build & data update scripts
   └───📂 public                  # Static assets served as-is

Environment badge

Set PUBLIC_ENVIRONMENT_BADGE to display a small text badge beside the header logo and wordmark, for example staging, test, or release/13.6. The value is public and rendered as text when Astro builds the site.

Local development (pnpm dev, including the frontend started by Aspire) defaults to localhost when the variable is unset. An explicitly empty or whitespace-only value hides the badge. Production builds have no badge by default; leave the variable unset or empty for live deployments.

To override the badge locally, set the variable in your shell or in src/frontend/.env.local and restart the dev server:

PUBLIC_ENVIRONMENT_BADGE=release/13.6

For the Azure DevOps vnext build, set this environment variable on the frontend build step, not only on the deployed host. Use the full release branch name:

env:
  PUBLIC_ENVIRONMENT_BADGE: $[replace(variables['Build.SourceBranch'], 'refs/heads/', '')]

For refs/heads/release/13.6, this renders release/13.6. Do not use Build.SourceBranchName, which keeps only the final path segment. Apply this setting only to the vnext build, not the live build. If vnext builds a different source branch, set the intended label explicitly instead. Changing the badge on a deployed static site requires rebuilding its frontend assets.

🆘 Getting help

📄 License

By contributing to this project, you agree that your contributions will be licensed under the same license as the project. See LICENSE for details.

🤝 Code of conduct

This project has adopted the Microsoft Open Source Code of Conduct. For more information, see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.