Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added links to SDK crate README pages #557

Merged
merged 1 commit into from
Mar 13, 2025
Merged

Added links to SDK crate README pages #557

merged 1 commit into from
Mar 13, 2025

Conversation

trmartin4
Copy link
Member

@trmartin4 trmartin4 commented Mar 12, 2025

📔 Objective

Our sdk-internal instructions ask engineers to look at the relevant crate README but did not link to those files. This PR adds links for easy reference. These felt stable enough to include as links as they should not change frequently.

⏰ Reminders before review

  • Contributor guidelines followed
  • All formatters and local linters executed and passed
  • Written new unit and / or integration tests where applicable
  • Protected functional changes with optionality (feature flags)
  • Used internationalization (i18n) for all UI strings
  • CI builds passed
  • Communicated to DevOps any deployment requirements
  • Updated any necessary documentation (Confluence, contributing docs) or informed the documentation
    team

🦮 Reviewer guidelines

  • 👍 (:+1:) or similar for great changes
  • 📝 (:memo:) or ℹ️ (:information_source:) for notes or general info
  • ❓ (:question:) for questions
  • 🤔 (:thinking:) or 💭 (:thought_balloon:) for more open inquiry that's not quite a confirmed
    issue and could potentially benefit from discussion
  • 🎨 (:art:) for suggestions / improvements
  • ❌ (:x:) or ⚠️ (:warning:) for more significant problems or concerns needing attention
  • 🌱 (:seedling:) or ♻️ (:recycle:) for future improvements or indications of technical debt
  • ⛏ (:pick:) for minor or nitpick changes

Copy link

Deploying contributing-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 35d54dd
Status: ✅  Deploy successful!
Preview URL: https://b0cff36b.contributing-docs.pages.dev
Branch Preview URL: https://sdk-links.contributing-docs.pages.dev

View logs

@trmartin4 trmartin4 changed the title Added links to SDK crates Added links to SDK crate README pages Mar 12, 2025
Copy link

Logo
Checkmarx One – Scan Summary & Detailse7ba0ad7-eca0-4fda-9691-57027cff6d63

Great job, no security vulnerabilities found in this Pull Request

@trmartin4 trmartin4 marked this pull request as ready for review March 12, 2025 21:05
@trmartin4 trmartin4 requested a review from a team as a code owner March 12, 2025 21:05
@trmartin4 trmartin4 merged commit d11333d into main Mar 13, 2025
9 checks passed
@trmartin4 trmartin4 deleted the sdk-links branch March 13, 2025 01:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants