Skip to content

Conversation

@lsharma-21
Copy link

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:] - (#126)

Full path to the refactored file: - src/search.js

What do you think this file does? - I think that this file takes in the inputs from searches and posts that users make on NodeBB and sorts them and finds them based on what the user wants to search/ sort by.

What is the scope of your refactoring within that file? - specifically updated sortPosts with a high complexity issue, fixed the issue by adding a helper function that did the sorting for things that were not numeric in a separate helper function called sortStringHelper()

Which Qlty‑reported issue did you address? - Function with high complexity (count = 10): sortPosts

2. Refactoring

How did the specific issue you chose impact the codebase’s maintainability? - It was difficult to understand and read the code due to how many if else statement in on block there were without many indications of what each if else did

What changes did you make to resolve the issue? - added a helper function sortStringHelper so that the main function was separated and as such had lower complexity and easier to understand

How do your changes improve maintainability? Did you consider alternatives? - this change improves the maintainability becaue of the fact that the seperate helper function os labled and can lead to a better and easier understanding of what that portion f code is met to do additionally you can not test the helper separately to see if it works

3. Validation

How did you trigger the refactored code path from the UI?

Attach a screenshot of the logs and UI demonstrating the trigger.
(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.

Screenshot 2026-01-23 at 9 03 38 PM

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