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

Added a bunch of extra documentation #138

Open
wants to merge 49 commits into
base: main
Choose a base branch
from
Open

Added a bunch of extra documentation #138

wants to merge 49 commits into from

Conversation

flimdejong
Copy link

@flimdejong flimdejong commented Sep 12, 2024

Comments for the reviewer

Pre pull request checklist:

Code Quality
  • Is the code is understandable and easy to read
  • Changes to the code comply with set clang-format rules
  • No use of manual memory control (e.g new/malloc/colloc etc)
  • Are (only) smart pointers used?
Testing
  • All tests are passing.
  • I added new / changed existing tests to reflect code changes (state why not otherwise!)
  • I tested my changes manually (Describe how, to what extent etc.)
Commit Messages
  • Commit message is saying what has been changed, why it was changed? Remember other developers might not know
    what the problem you are fixing was. Note also negative decision (e.g., why did you not do particular thing)
    TLDR: Commit message are comprehensive
  • Commit messages follows the rules of https://chris.beams.io/posts/git-commit/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants