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 explicit contributing docs reference to template #58

Merged
merged 2 commits into from
Jan 19, 2024

Conversation

trmartin4
Copy link
Member

🚧 Type of change

  • 🎂 Other

📔 Objective

In a retro, we discussed the benefit of calling out that we should look to ensure any documentation is up to date when submitting a PR. This change will explicitly reference Confluence and our contributing docs.

📋 Code changes

  • PULL_REQUEST_TEMPLATE.md: Added explicit documentation references.

⏰ 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 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

@trmartin4 trmartin4 requested a review from a team as a code owner January 19, 2024 14:59
@bitwarden-bot
Copy link

bitwarden-bot commented Jan 19, 2024

Logo
Checkmarx One – Scan Summary & Detailsd7d497c2-ebc3-497b-a599-469afe0c3605

No New Or Fixed Issues Found

@trmartin4 trmartin4 merged commit ad932f1 into main Jan 19, 2024
2 checks passed
@trmartin4 trmartin4 deleted the add-contributing-docs-to-template branch January 19, 2024 15:55
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.

3 participants