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

Streamline readme #10

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Streamline readme #10

wants to merge 1 commit into from

Conversation

snadi
Copy link

@snadi snadi commented Nov 10, 2022

Here are further comments/questions I have:

  • Mention the version of RefactoringMiner that you used

For running:

  • It is not clear what Step 4 is and which configuration files to edit. So I need to edit a config file whenever I need to run it?. Perhaps also point that this can be automated and link to the evaluation repo? "This works when..." not clear what this means here. In general, this step is confusing. Please clarify

  • what should the user see after Step 5? and where will they see it?

For adding new refactoring part:

  • please add a list of supported refactorings somewhere in the repo.

  • For example, Move Method will come before Rename Variable and after Move Class. ==> example is not clear.. aren't variables "lower" in the hierarchy? Or are there special cases?

  • For step 3.2, where should they add the related simplification logic in the code? The step also says just "logic" ... which logic?

  • Similar for step 3.3, where should this be added... Also, what does "combined" mean here?

  • Step 5: wasn't all that conflict logic done in the previous step? What is the "logic matrix".. Perhaps first, you should have an overview of how the code is structured (very briefly) and the terms you use.. You loosely use "logic" and "matrix" but someone not familiar with the details will not get this. Also the steps there aren't clear.. What is "dispatcher and receiver hashmaps." ?

  • Step 6.1. "for rename method is RefactoringFactory and RenameRefactoring." -- why is it RefactoringFactor? Why not just "RenameFactory".. Also, what is a refactoring processor? You mean one of IntelliJ's existing processors?

  • Step 7 "In most cases, the refactoring process to replay the refactoring will be the same." --> same as what

@snadi snadi requested a review from max-ellis November 10, 2022 09:26
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