Conversation
chrisjamiecarter
left a comment
There was a problem hiding this comment.
Hey @MartinDrapak 👋,
Excellent work on your Coding Tracker project submission 🎉!
I have performed a peer review. Review/ignore any comments as you wish.
🟢 Requirements
⭐ You have fulfilled all of the project requirements!
🟠 Solution Structure
💡 As per the academy's Code Reviews page. I was expecting your project submission to be contained in a folder in the format: [ProjectName].[GitHubUserName].
👨🏫 For example, CodingTracker.MartinDrapak
💭 This will make it easier for code-reviewers to pull down and review your code in the future. This will also make sense when you get to the projects with other students code in.
🟠 Style Guide Compliance
💡 Remember that when you have finished a project, give it a polish pass. Refer to the Academy's code-conventions page.
💭 This is important as good code conventions/styling ensures consistency, makes your code easier for others to read and maintain, and improves your chances of getting a pull request reviewed and approved.
🟠 README File
💡 One way to take your submission to the next level is by including a README file. This small addition can make a big difference!
💭 A README file is like an introduction to your project—it can briefly explain the purpose of your code, provide instructions for running it, and highlight any unique features you've included. It makes your work more accessible to others, whether they're peers, mentors, or even future employers.
I will go ahead and mark as approved, keep up the excellent work on the next projects! 😊
Best regards,
@chrisjamiecarter 👍
There was a problem hiding this comment.
🟠 Database In Repository
❗Database's should not be included with source code
| using System.Linq; | ||
| using Dapper; | ||
|
|
||
| namespace CodingTracker |
There was a problem hiding this comment.
🟠 Namespaces
As per the academy's code-conventions - Use the newest namespaces.
Use file-scoped namespaces to save an indentation level:
❌
// Block-Scoped Namespace
namespace YourNamespace
{
// Code here...
}
✔️
// File-Scoped Namespace
namespace YourNamespace;
// Code here...
| /// <summary> | ||
| /// This class is responsible for interacting with the SQLite database. | ||
| /// </summary> | ||
| class DatabaseInteractor |
There was a problem hiding this comment.
🟠 Explicit Accessibility
💡 Declare 'public', protected, internal, private
| return false; | ||
| } | ||
| } | ||
| #endregion |
There was a problem hiding this comment.
🟡 Compact Code
💡 Let your code breathe. Whitespace makes your code easier to read.
public class SomeClass
{
public method SomeMethod()
{
}
// <=== Note Whitespace here
public method SomeOtherMethod()
{
}
}
No description provided.