Skip to content

Conversation

@ahmedalkawaz
Copy link

@ahmedalkawaz ahmedalkawaz commented Jan 23, 2026

…tartEnd. Did so by adding helper functions.

P1B: Starter Task: Refactoring PR

Use this pull request template to briefly answer the questions below in one to two sentences each.
Feel free to delete this text at the top after filling out the template.

You are not permitted to use generative AI services (e.g., ChatGPT) to compose the answers.
Any such use will be treated as a violation of academic integrity.

1. Issue

Link to the associated GitHub issue: #149

Full path to the refactored file: src/topics/posts.js

What do you think this file does?
Renders the posts for the client. I think this because my function activates when you head to the posts section.

What is the scope of your refactoring within that file?
Topics.getTopicPosts and addEventStartEnd(...)

Which Qlty‑reported issue did you address?

  • Function with high complexity (count = 30): addEventStartEnd*

2. Refactoring

How did the specific issue you chose impact the codebase’s maintainability? The issue makes the codebase harder to maintain. The high complexity of the function makes it harder to understand and thus work with. Any errors/scaling efforts would be made more difficult.

What changes did you make to resolve the issue? I split the function into multiple helper functions, overall decreasing complexity and increasing modularity.

How do your changes improve maintainability? Did you consider alternatives? The changes increased modularity because the function is now broken up into multiple smaller, easily digestible pieces. This allows parts of it to be reused, as well as making it easier to understand. It is now easier to test the different parts of the function as well as implement any new features in which the function would be relevant.

3. Validation

How did you trigger the refactored code path from the UI? In NodeBB click on general discussion, then click on one of the posts.

Attach a screenshot of the logs and UI demonstrating the trigger.
Screenshot 2026-01-23 at 3 39 17 PM
Screenshot 2026-01-23 at 4 23 48 PM

(If you refactored a public/src/ file (front-end related file), watch logging via DevTools (Ctrl+Shift+I to open and then navigate to the 'Console' tab). If you refactored a src/ file, watch logging via ./nodebb log. Include the relevant UI view. Temporary logs should be removed before final commit.)

Attach a screenshot of qlty smells --no-snippets <full/path/to/file.js> showing fewer reported issues after the changes.
image

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.

1 participant