Skip to content

Instantly share code, notes, and snippets.

View wsignor's full-sized avatar

Wagner Signoretti wsignor

View GitHub Profile
@wsignor
wsignor / effective-code-review.md
Created June 4, 2024 15:03
Effective Code Review

Effective Code Review

Reviewing pull requests is a critical part of the software development process. It ensures code quality, adherence to standards, and catches potential issues before they reach the production environment. Following are the main topics that should be addressed in the code review process:

1. Understand the Context:

  • Read the PR description and make sure you understand the rationale behind the changes.
  • Read the Acceptance Criteria (AC) and make sure everything is covered.
  • Consider the impact of this PR on the overall system and its users. If critical, will the team have time to validate and test this change before releasing? What kind of test is required? Should we target this for a major release? Are other projects impacted by this change? Should representatives be added as reviewers? Etc.
@wsignor
wsignor / IntelliJ-AI-Assistant.md
Last active June 4, 2024 10:13
First impressions of IntelliJ AI Assistant

First impressions of IntelliJ AI Assistant

The IntelliJ AI Code Assistant brings nice features to the traditional IntelliJ IDE. On the positive side, its chat interface provides context-aware assistance, and the code generation tool is useful for basic implementations. However, it falls short in deep code analysis, personalised answers, and comprehensive error logs.

Breaking down the main features

Feature Review
Chat with AI Assistant to ask questions related to your project or iterate on a task. The AI Assistant provides an open-ended chat interface right within the IDE, which gathers a bit of context about your project and can answer simple questions about it. I was honestly expecting it to leverage all available information more effectively. When faced with deeper or complex queries, it falls short.
Use prompts to explain and refactor your code. It doesn’t go further than a basic refactor. I tried using the "AI magic refactor" tools to extract parts of
/build
/build
/build
@wsignor
wsignor / app_.gitignore
Created September 12, 2015 08:36
tccendo
/build