Skip to content

Commit

Permalink
fix (task.md) removed the headlines morkdown formatting, fixes https:…
Browse files Browse the repository at this point in the history
…//youtrack.jetbrains.com/issue/EDC-1114.

Also added Refactoring and its Purpose custom name

(cherry picked from commit 03641e5)
  • Loading branch information
Geravant committed Dec 20, 2024
1 parent f6032f1 commit 59260f9
Show file tree
Hide file tree
Showing 40 changed files with 40 additions and 39 deletions.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Section 2: Code style and Formatting
Section 2: Code style and Formatting

In this section, we will cover the following topics:
- The concepts of code style and formatting
Expand Down
2 changes: 1 addition & 1 deletion CodeStyleAndFormatting/WhatIsFormatting/Quiz/task.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
# Task 2/4: What is the primary benefit of following consistent code formatting?
Task 2/4: What is the primary benefit of following consistent code formatting?
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Task 3/4: Reformat the code
Task 3/4: Reformat the code

### Task

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Task 4/4: Reformat the code using IDE
Task 4/4: Reformat the code using IDE

### Theory

Expand Down
2 changes: 1 addition & 1 deletion CodeStyleAndFormatting/WhatIsFormatting/Theory/task.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Task 1/4: What is formatting?
Task 1/4: What is formatting?

**_Code style_** is a set of guidelines used in a development team on how to write code.
Usually, the code style depends on the programming language and developers’ preferences and includes rules about formatting,
Expand Down
2 changes: 1 addition & 1 deletion Conclusion/Conclusion/Conclusion/task.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Section 8: Conclusion
Section 8: Conclusion

Congratulations! 🎉

Expand Down
2 changes: 1 addition & 1 deletion Conclusion/FeedbackSurvey/FeedbackSurvey/task.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Feedback survey
Feedback survey

Thank you for taking our Introduction to IDE Code Refactoring in Java course!
We would really appreciate it if you could take a few minutes to
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Section 3: Extracting code
Section 3: Extracting code

In this section, we will cover the following topics:
- Long method code smell
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Task 2/2: Extract duplicated code
Task 2/2: Extract duplicated code

### Task

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Task 1/2: What is Extract Method refactoring?
Task 1/2: What is Extract Method refactoring?

As we mentioned before, **duplicated code can lead to undesirable effects**. For example, if you fix a bug in one place
but forget to fix it consistently in duplicates,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Task 2/2: Extract magic numbers
Task 2/2: Extract magic numbers

### Task

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Task 1/2: What is Extract Variable refactoring?
Task 1/2: What is Extract Variable refactoring?

A *magic number* is a numerical value used in the code without a comment explaining its purpose.
Using magic numbers in code is considered bad practice because it makes the code prone to errors and less maintainable and readable.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Task 2/2: Inline methods and variables
Task 2/2: Inline methods and variables

### Task

Expand Down
2 changes: 1 addition & 1 deletion InliningCode/InlineMethodRefactoring/Theory/task.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Task 1/2: Inline Method refactoring
Task 1/2: Inline Method refactoring

Apply the Inline Method refactoring when a method's behavior is simple and its purpose is clear, but it is called from only one place.
If the method has become redundant or does not add significant value, it can be safely inlined.
Expand Down
2 changes: 1 addition & 1 deletion InliningCode/Introduction/InliningCodeIntroduction/task.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Section 6: Inlining code
Section 6: Inlining code

In this section, we will cover the following topics:
- Inline Variable refactoring
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Task 2/2: What is Inline Variable refactoring?
Task 2/2: What is Inline Variable refactoring?

In this task, you need to identify unnecessary variables and inline them using the automatic Inline
refactoring.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Task 1/2: What is Inline Variable refactoring?
Task 1/2: What is Inline Variable refactoring?

We apply the **Inline refactoring** to simplify code by removing unnecessary method or variable declarations and directly
replacing them with their respective expressions or values.
Expand Down
2 changes: 1 addition & 1 deletion MovingCode/CohesionAndCoupling/Quiz/task.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
# Task: 2/2: In software design, what should be the ideal relationship between cohesion and coupling?
Task: 2/2: In software design, what should be the ideal relationship between cohesion and coupling?
2 changes: 1 addition & 1 deletion MovingCode/CohesionAndCoupling/Theory/task.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Task: 1/2: Cohesion and coupling
Task: 1/2: Cohesion and coupling

_**Cohesion**_ and _**coupling**_ are fundamental concepts in software design that determine how well system components
are organized and interact with each other. Move refactorings can play a crucial role in improving
Expand Down
2 changes: 1 addition & 1 deletion MovingCode/Introduction/MovingCodeIntroduction/task.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Section 4: Moving code
Section 4: Moving code

In this section, we will cover the following topics:

Expand Down
Original file line number Diff line number Diff line change
@@ -1 +1 @@
# Task 2/2: Which of the following is a code smell?
Task 2/2: Which of the following is a code smell?
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Task 1/2: Common code issues and their impact on code quality
Task 1/2: Common code issues and their impact on code quality

Martin Fowler introduced the term **_code smell_** to indicate potential issues or shortcomings in code
implementation. That doesn’t necessarily mean that the code has bugs, but the smell makes code understanding, developing, and
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Task 1/1: Getting familiar with IDE refactoring features
Task 1/1: Getting familiar with IDE refactoring features

There are two places to explore available refactoring actions in the IDE: the **Refactor This** and **Search Everywhere**
dialogs.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Section 1: Refactoring and its purpose
Section 1: Refactoring and its purpose

In this section, we will cover the following topics:
- Refactoring definition
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
type: edu
custom_name: "Refactoring And Its Purpose: Practice"
files:
- name: test/IdentifyIssuesInCodeSnippetTest.java
visible: false
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Task 1/1: Identify code issues and fix them
Task 1/1: Identify code issues and fix them

### Task

Expand Down
Original file line number Diff line number Diff line change
@@ -1 +1 @@
# Task 2/2: What is the primary difference between "root-canal" refactoring and "floss" refactoring?
Task 2/2: What is the primary difference between "root-canal" refactoring and "floss" refactoring?
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Task 1/2: Refactoring techniques
Task 1/2: Refactoring techniques

Developers refactor code to achieve different goals.
Sometimes, refactoring is the goal in itself: for example, when splitting one monolith project into several microservices.
Expand Down
Original file line number Diff line number Diff line change
@@ -1 +1 @@
# Task 2/2: What is the purpose of refactoring in software development?
Task 2/2: What is the purpose of refactoring in software development?
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Task 1/2: What is code refactoring?
Task 1/2: What is code refactoring?

**_Refactoring_** is a process of modifying source code without changing its behavior. For example, this could involve renaming a method or
extracting a _magic constant_ into a separate variable. It improves code readability but doesn’t change what the code does.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Task 1/1: Design patterns and their relationship with refactoring
Task 1/1: Design patterns and their relationship with refactoring

Design patterns are reusable solutions to common problems that software developers face during the design and
implementation of their applications.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Task 1/1: Facade Pattern – Theory
Task 1/1: Facade Pattern – Theory

The **Facade** is a _structural pattern_ that provides a simplified interface
to a complex system of classes, libraries, or APIs.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Task 1/1: Factory Method Pattern – Theory
Task 1/1: Factory Method Pattern – Theory

The **Factory Method** is a _creational design pattern_ that provides an interface for creating objects
in a superclass, while allowing subclasses to alter the type of objects that will be created.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Section 7: Refactoring to Design Patterns
Section 7: Refactoring to Design Patterns

In this section, we will dive into the fundamental concepts of design patterns and explore how refactorings can shape
the structure of your software systems.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Task 1/1: Strategy Pattern – Theory
Task 1/1: Strategy Pattern – Theory

The **Strategy** is a _behavioral pattern_ that allows you to define a family of algorithms,
encapsulate each algorithm, and make them interchangeable.
Expand Down
2 changes: 1 addition & 1 deletion RenamingCode/NamingRules/Quiz/task.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
# Task 2/2: Which of the following is a characteristic of a good name?
Task 2/2: Which of the following is a characteristic of a good name?
2 changes: 1 addition & 1 deletion RenamingCode/NamingRules/Theory/task.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Task 1/2: Naming rules
Task 1/2: Naming rules

Naming is one of the most important parts of code writing, as it significantly affects code understandability.
A good name should be **descriptive**, **unambiguous** and clearly reflect what the code does.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Task 3/3: Fix typos, change the code to comply with naming rules and camelCase convention
Task 3/3: Fix typos, change the code to comply with naming rules and camelCase convention

### Task

Expand Down
2 changes: 1 addition & 1 deletion RenamingCode/RenameRefactoringInIDE/Quiz/task.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
# Task 2/3: Which of the following code element names demonstrates good naming practice?
Task 2/3: Which of the following code element names demonstrates good naming practice?
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Task 1/3: Rename refactoring in IDE
Task 1/3: Rename refactoring in IDE

If you want to rename a code entity, you can click on the entity’s name and press the
**&shortcut:RenameElement;** (macOS) or **Shift+F6** (Windows/Linux) shortcut.
Expand Down

0 comments on commit 59260f9

Please sign in to comment.