Staging #162
Merged
Staging #162
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mhamidjamil
added
documentation
|
Resolve conflicts then ping me please. |
|
Please have a look I have resolved conflicts. |
This was
linked to
issues
Mar 13, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Details
The code does the intended while also ensuring that it does not cause side-effects or compromise the system performance and functionality.Details
The code is neither too simple and long (over-engineering) nor too short and complex for peers. With a complex code, devs are likely to introduce bugs when calling or modifying the code.Details
The style guide of project is followed e.g. linting, formatting, types, and other standards. Any style point differing from the guide should not be combined with other changes, as it makes it hard to see what is being changed.Details
SOLID principles are used efficiently, making the code reusable and scalable.Details
The code is readable and comprehensive. Comments are clear, useful, and explain why instead of what.Details
Tests should be added, as appropriate, in the same changelist as the code. Tests should be correct, sensible, and useful.Details
Devs should update associated documentation. If code is deleted or deprecated, then the documentation should also be deleted.