Streamline Your Code Reviews with SHIP SHOW ASK: A Modern Approach

rouretl

Lucas ROURET

Posted on August 11, 2024

Streamline Your Code Reviews with SHIP SHOW ASK: A Modern Approach

Pull Requests (PRs) are a crucial tool in the life of any tech project. They enable the introduction of new features and bug fixes, but they offer much more than that!

  • They foster discussion
  • Help identify business logic errors
  • Improve code quality
  • Facilitate knowledge sharing šŸ”„

In the tech world, practices have evolved significantly over the years. With faster development cycles and teams becoming more autonomous, itā€™s important to adapt our working methods.

āž”ļø One such adaptation involves rethinking how we manage code changes within the team.

Development teams are increasingly valuing autonomy. In this context, itā€™s crucial to strike a balance between rigor and flexibility in our processes. This is where the "SHIP SHOW ASK" method comes into play, aligning perfectly with this new dynamic.

But be aware, not all code changes are created equal. Some are critical and require immediate attention, while others are minor and can be handled with less formality. To address this variety, flexible approaches like "SHIP SHOW ASK" have emerged, allowing the review process to be tailored based on the nature of the change.

Introducing the SHIP SHOW ASK Method

"SHIP SHOW ASK" is a method that enables development teams to deliver code quickly while maintaining transparency and collaboration within the team. It consists of three key steps that adapt to different types of code changes: SHIP, SHOW, and ASK.


SHIP: for Quick Changes

SHIP

When a developer identifies a change that doesnā€™t require a thorough code reviewā€”such as a minor fix or a documentation updateā€”they can make this change directly on the main branch. The "SHIP" approach assumes that these changes are safe enough to be integrated without waiting for approval from other team members.

Why "SHIP" works well from a developer's perspective:

  • "Iā€™ve added a feature using an established pattern."
  • "Iā€™ve fixed a minor bug."
  • "Iā€™ve updated the documentation."
  • "Iā€™ve improved my code based on previous feedback."

SHOW: Merging with Confidence

SHOW

In the "SHOW" stage, you work on a dedicated branch and open a PR. The key difference here is that you donā€™t need to wait for someone else to review your code before merging. You rely on automated checks (unit tests, code coverage, preview deployments, etc.) to ensure your code is ready. Once everything checks out, you merge and notify your team. They can then review what youā€™ve done, provide feedback, ask questions, or simply learn from your work.

Examples:

  • "Take a look at this new approach or model Iā€™ve used."
  • "Iā€™ve refactored X, hereā€™s the outcome."
  • "Iā€™ve fixed a bug; hereā€™s how I did it."

ASK: Seeking Feedback and Collaboration

ASK

"ASK" comes into play when youā€™re uncertain about the approach youā€™ve taken or when you think feedback from your team could improve the quality of your code. You work on a dedicated branch, open a Pull Request, and wait for feedback before merging.

This approach is ideal for situations where:

  • Youā€™re unsure if your solution is the best one.

  • You need help improving your code.

  • Youā€™re working on a new feature or a major refactoring.


Understanding the Limitations of SHIP SHOW ASK

Here are some factors that limit the application of "SHIP SHOW ASK":

  • Lack of Continuous Deployment (CD) in the project.

  • Working with an unfamiliar or frequently changing team.

  • Lack of expertise within the team on the technologies used.

  • Lack of trust and discipline within the team.

These factors hinder the effectiveness of "SHIP SHOW ASK" by creating barriers to autonomy, responsiveness, and effective collaboration within the team.

Personal Insights on SHIP SHOW ASK

āš ļø This section reflects my PERSONAL opinion, providing you with my experience. Itā€™s not adviceā€”make your own judgment on "SHIP SHOW ASK" šŸ˜Ž

I genuinely believe that "SHIP SHOW ASK" is a great method, but there are prerequisites.

āž”ļø You need to trust your team and know them well. It might seem trivial, but knowing that your team members wonā€™t SHIP a "while true" loop is crucial!

āž”ļø Know the project.

āž”ļø Know your strengths and weaknesses (strengths => SHOW, weaknesses => ASK). This will help you understand when to ask for help and how to learn from your teamā€™s feedback.

Conclusion: Balancing Speed and Quality in Development

In conclusion, "SHIP SHOW ASK" is a versatile method that empowers development teams to balance speed and quality in their workflows. By categorizing changes into SHIP, SHOW, and ASK, teams can streamline their processes, foster collaboration, and maintain high standards of code quality. However, the success of this method hinges on trust, familiarity with the project, and a clear understanding of team dynamics. When these prerequisites are met, "SHIP SHOW ASK" can significantly enhance productivity and team cohesion, making it a valuable approach in modern software development.

Hi, I'm Lucas Rouret, a Web and Mobile Software Engineer passionate about technology since I was 15. I mainly work with JavaScript and TypeScript. Currently, I'm working on 2 startups
Interested in my content? Follow me on X (Twitter) and subscribe to my newsletter for weekly posts and detailed development logs. Join a community of tech enthusiasts now!

šŸ”„ Check out my latest article "Boost Your React App's UX: Comprehensive Error Handling with Error Boundaries"

Source:

šŸ’– šŸ’Ŗ šŸ™… šŸš©
rouretl
Lucas ROURET

Posted on August 11, 2024

Join Our Newsletter. No Spam, Only the good stuff.

Sign up to receive the latest update from our blog.

Related