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

Review codebase #1

Open
MichaelJHTaggart opened this issue Nov 11, 2024 · 0 comments
Open

Review codebase #1

MichaelJHTaggart opened this issue Nov 11, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@MichaelJHTaggart
Copy link
Owner

Non-Technical Breakdown:

This review is like a "house inspection." Imagine this code is a house that hasn’t been lived in for 10+ years. Right away, we should expect that there will be work required. But before we dive into fixing things, we need to conduct an inspection to understand the current state of the project.

Example:
If we find that the house is built over a large sinkhole, fixing the leaky roof probably is not the first priority. We need to get an understanding of the existing code so that we can prioritize tasks


Technical Breakdown:

Here’s a guide on how to review the codebase, organized into key focus areas:


The code-review.md will be the file that tracks the progress of answering the questions for the review:

Feel free to contribute!
https://github.com/MichaelJHTaggart/VortexWars/blob/master/code-review.md

@MichaelJHTaggart MichaelJHTaggart self-assigned this Nov 11, 2024
@MichaelJHTaggart MichaelJHTaggart converted this from a draft issue Nov 11, 2024
@MichaelJHTaggart MichaelJHTaggart added documentation Improvements or additions to documentation good first issue Good for newcomers labels Nov 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
Status: In progress
Development

When branches are created from issues, their pull requests are automatically linked.

1 participant