Skip to content

  • Projects
  • Groups
  • Snippets
  • Help
    • Loading...
    • Help
    • Submit feedback
    • Contribute to GitLab
  • Sign in
H
haskell-bee
  • Project
    • Project
    • Details
    • Activity
    • Releases
    • Cycle Analytics
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
    • Charts
  • Issues 1
    • Issues 1
    • List
    • Board
    • Labels
    • Milestones
  • Merge Requests 1
    • Merge Requests 1
  • CI / CD
    • CI / CD
    • Pipelines
    • Jobs
    • Schedules
    • Charts
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Members
    • Members
  • Collapse sidebar
  • Activity
  • Graph
  • Charts
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
  • gargantext
  • haskell-bee
  • Merge Requests
  • !1

Open
Opened Aug 27, 2024 by Alfredo Di Napoli@AlfredoDiNapoli
  • Report abuse
Report abuse

Code review (part I)

I'm out of time for this week, but here is an initial code review of the library (cc @anoe). I haven't reviewed the operational semantic / runtime correctness, as that would escalate more into the code audit area, and it's much more time consuming to do. I have focused on general code best practices and general design considerations.

@cgenie I have structured the commits such that you can cherry pick or ignore them as you see fit, as you might not agree with the rational behind each of them. There is also a REVIEW.md that explain things, and each commit should have a description explaining the rationale. The most interesting thing for you will be the last paragraph of the REVIEW.md where I describe an alternative design based on record-of-functions. I'm out of time this week, but if you are interested to see how this would look like, I'm happy to come up with a sketch, to compare the two and see if there is a winning design for this particular scenario.

I hope this helps!

Check out, review, and merge locally

Step 1. Fetch and check out the branch for this merge request

git fetch origin
git checkout -b adinapoli/code-review origin/adinapoli/code-review

Step 2. Review the changes locally

Step 3. Merge the branch and fix any conflicts that come up

git fetch origin
git checkout origin/master
git merge --no-ff adinapoli/code-review

Step 4. Push the result of the merge to GitLab

git push origin master

Note that pushing to GitLab requires write access to this repository.

Tip: You can also checkout merge requests locally by following these guidelines.

  • Discussion 1
  • Commits 7
  • Pipelines 1
  • Changes 10
Assignee
Assign to
None
Milestone
None
Assign milestone
Time tracking
0
Labels
None
Assign labels
  • View project labels
Reference: gargantext/haskell-bee!1