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

Add community PR process documentation #471

Merged
merged 3 commits into from
Nov 13, 2024
Merged

Conversation

trmartin4
Copy link
Member

@trmartin4 trmartin4 commented Nov 9, 2024

🎟️ Tracking

N/A

📔 Objective

Provide clarity for our community contributors around what our internal processes are for managing contributions. This is intended to be high-level enough that it doesn't have to change based on individual teams' implementation details around how they manage community PRs, but instead give contributors insight into what the communication points are likely to be when they submit a PR and help them understand why some PRs might take longer than others.

Once deployed, I intend to change the auto-generated message on all community PRs to include a link to this page,.

⏰ 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

cloudflare-workers-and-pages bot commented Nov 9, 2024

Deploying contributing-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 539ba43
Status: ✅  Deploy successful!
Preview URL: https://ac6fc582.contributing-docs.pages.dev
Branch Preview URL: https://add-community-pr-process.contributing-docs.pages.dev

View logs

Copy link

github-actions bot commented Nov 9, 2024

Logo
Checkmarx One – Scan Summary & Details7002d685-679c-409f-9167-fccd51ee7442

No New Or Fixed Issues Found

@trmartin4 trmartin4 marked this pull request as ready for review November 9, 2024 18:38
@trmartin4 trmartin4 requested a review from a team as a code owner November 9, 2024 18:38
@trmartin4 trmartin4 changed the title Add-community-pr-process Add community PR process documentation Nov 9, 2024
@trmartin4 trmartin4 added the adr label Nov 9, 2024
withinfocus
withinfocus previously approved these changes Nov 12, 2024
Copy link
Contributor

@withinfocus withinfocus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorta-opinionated suggestions.

## Product assessment

When your community contribution is received, the first step is for our Product team to evaluate
whether the change aligns with the vision for the Bitwarden product. This is more relevant for
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
whether the change aligns with the vision for the Bitwarden product. This is more relevant for
whether the change aligns with the vision for the Bitwarden products. This is more relevant for

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Addressed with 539ba43 (#471).

## Engineering assessment

The Engineering team(s) responsible for the change depend largely on what code was changed. We use
Github code owners to manage the areas in our repositories owned by each team, and the responsible
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Github code owners to manage the areas in our repositories owned by each team, and the responsible
GitHub code owners to manage the areas in our repositories owned by each team, and the responsible

Copy link
Member Author

@trmartin4 trmartin4 Nov 12, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Addressed with 539ba43 (#471)


:::

The responsible Engineering teams will review the change and ensure that there are no concerns
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The responsible Engineering teams will review the change and ensure that there are no concerns
The responsible Engineering team(s) will review the change and ensure that there are no concerns

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Addressed with 539ba43 (#471).

:::

The responsible Engineering teams will review the change and ensure that there are no concerns
around how the change was implemented. This is generally more applicable for larger sets of changes,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
around how the change was implemented. This is generally more applicable for larger sets of changes,
around how the change was implemented; this is generally more applicable for larger sets of changes,

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Addressed with 539ba43 (#471).

@trmartin4 trmartin4 merged commit 0132b95 into main Nov 13, 2024
9 checks passed
@trmartin4 trmartin4 deleted the add-community-pr-process branch November 13, 2024 02:28
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