Skip to content

Conversation

@CBID2
Copy link
Contributor

@CBID2 CBID2 commented Aug 27, 2023

Description

This PR adds an explainer page about PR velocity. This would help new users of OpenSauced gain a better understanding of this feature and how it can aid them.

What type of PR is this? (check all applicable)

  • 🍕 Feature
  • 🐛 Bug Fix
  • 📝 Documentation Update
  • 🎨 Style
  • 🧑‍💻 Code Refactor
  • 🔥 Performance Improvements
  • ✅ Test
  • 🤖 Build
  • 🔁 CI
  • 📦 Chore (Release)
  • ⏩ Revert

Related Tickets & Documents

Fixes #142

Mobile & Desktop Screenshots/Recordings

Added tests?

  • 👍 yes
  • 🙅 no, because they aren't needed
  • 🙋 no, because I need help

Added to documentation?

  • 📜 README.md
  • 📓 docs.opensauced.pizza
  • 🍕 dev.to/opensauced
  • 📕 storybook
  • 🙅 no documentation needed

[optional] Are there any post-deployment tasks we need to perform?

[optional] What gif best describes this PR or how it makes you feel?

@netlify
Copy link

netlify bot commented Aug 27, 2023

Deploy Preview for docs-open ready!

Name Link
🔨 Latest commit ea29862
🔍 Latest deploy log https://app.netlify.com/sites/docs-open/deploys/64ee87ecd93aa70008074e9c
😎 Deploy Preview https://deploy-preview-151--docs-open.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@CBID2 CBID2 self-assigned this Aug 27, 2023
@CBID2 CBID2 requested a review from bdougie August 27, 2023 19:33
@bdougie bdougie merged commit 619574f into open-sauced:main Aug 30, 2023
@CBID2 CBID2 deleted the adding-pr-velocity-explainer-page branch August 30, 2023 00:06
github-actions bot pushed a commit that referenced this pull request Aug 30, 2023
## [1.41.0](v1.40.1...v1.41.0) (2023-08-30)

### Features

* add explainer page about PR velocity ([#151](#151)) ([619574f](619574f))
@github-actions
Copy link
Contributor

🎉 This PR is included in version 1.41.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

github-actions bot pushed a commit that referenced this pull request Aug 30, 2023
* feat: add explainer page about PR velocity

* fix: improved keywords

* fix: the journey to revising metadata continues

* Update docs/community/pr-velocity.md

---------

Co-authored-by: Brian Douglas <bdougie@users.noreply.github.com> 619574f
@neon-script
Copy link

As of my last knowledge update in January 2023, "PR velocity" typically refers to the rate at which pull requests (PRs) are created, reviewed, and merged in a GitHub repository. It is a metric used to assess the efficiency and productivity of a development team or project. Here's an explanation of PR velocity in the context of GitHub:

Pull Request (PR): In Git-based version control systems like GitHub, a pull request is a proposed change to the codebase. It allows contributors to submit changes for review before merging them into the main branch.

Velocity: In agile development methodologies, velocity is a measure of the amount of work completed in a given time frame. It is often used to plan and track the progress of a development team.

PR Velocity: When applied to GitHub, PR velocity is a measure of the speed and efficiency with which pull requests are processed. It encompasses the entire lifecycle of a PR, from its creation to review and eventual merge.

Creation Rate: The frequency at which new pull requests are opened. A higher creation rate might indicate an active development cycle.

Review Time: The time taken for reviewers to assess and provide feedback on a pull request. Shorter review times are generally associated with higher velocity.

Merge Time: The time it takes to merge a pull request after it has been approved. A quick merge time contributes to a higher PR velocity.

Closed or Rejected Rate: The percentage of pull requests that are closed or rejected without being merged. A low closed/rejected rate might indicate a successful and collaborative development process.

Overall Turnaround Time: The total time taken from the creation of a pull request to its successful merge. A lower overall turnaround time suggests a faster and more efficient development workflow.

Monitoring and Improvement: Teams can use PR velocity as a key performance indicator (KPI) to monitor their development process. If the velocity is consistently low, it might indicate bottlenecks or inefficiencies that need addressing. Regularly analyzing PR velocity can help teams identify areas for improvement in their development workflow.

It's important to note that the specifics of PR velocity can vary between teams and projects, and the interpretation of these metrics depends on the context of the development process in place. Additionally, GitHub itself provides various features and integrations that allow teams to track and analyze their development metrics. Always refer to the most recent GitHub documentation for the latest features and practices.

@CBID2
Copy link
Contributor Author

CBID2 commented Jan 5, 2024

As of my last knowledge update in January 2023, "PR velocity" typically refers to the rate at which pull requests (PRs) are created, reviewed, and merged in a GitHub repository. It is a metric used to assess the efficiency and productivity of a development team or project. Here's an explanation of PR velocity in the context of GitHub:

Pull Request (PR): In Git-based version control systems like GitHub, a pull request is a proposed change to the codebase. It allows contributors to submit changes for review before merging them into the main branch.

Velocity: In agile development methodologies, velocity is a measure of the amount of work completed in a given time frame. It is often used to plan and track the progress of a development team.

PR Velocity: When applied to GitHub, PR velocity is a measure of the speed and efficiency with which pull requests are processed. It encompasses the entire lifecycle of a PR, from its creation to review and eventual merge.

Creation Rate: The frequency at which new pull requests are opened. A higher creation rate might indicate an active development cycle.

Review Time: The time taken for reviewers to assess and provide feedback on a pull request. Shorter review times are generally associated with higher velocity.

Merge Time: The time it takes to merge a pull request after it has been approved. A quick merge time contributes to a higher PR velocity.

Closed or Rejected Rate: The percentage of pull requests that are closed or rejected without being merged. A low closed/rejected rate might indicate a successful and collaborative development process.

Overall Turnaround Time: The total time taken from the creation of a pull request to its successful merge. A lower overall turnaround time suggests a faster and more efficient development workflow.

Monitoring and Improvement: Teams can use PR velocity as a key performance indicator (KPI) to monitor their development process. If the velocity is consistently low, it might indicate bottlenecks or inefficiencies that need addressing. Regularly analyzing PR velocity can help teams identify areas for improvement in their development workflow.

It's important to note that the specifics of PR velocity can vary between teams and projects, and the interpretation of these metrics depends on the context of the development process in place. Additionally, GitHub itself provides various features and integrations that allow teams to track and analyze their development metrics. Always refer to the most recent GitHub documentation for the latest features and practices.

Hi @YOGINIMAHIMA1! :) Can you provide a link to resources that supports your points?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: Explaination on certain parts of the insights page

3 participants