Skip to content

Commit

Permalink
Added Images
Browse files Browse the repository at this point in the history
  • Loading branch information
Senyr committed Dec 15, 2023
1 parent 909a7af commit 6cf0de9
Show file tree
Hide file tree
Showing 9 changed files with 51 additions and 8 deletions.
24 changes: 20 additions & 4 deletions essays/CodingStandards.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,29 @@ labels:

## The Importance of Coding Standards

When it comes to coding standards, everyone has their own opinion. Some wonder if these rules and guidelines truly help us write better code. In my personal view, coding standards may not directly improve the functionality of our code, but they play a crucial role in making our code look presentable and easy to understand. This is important for several reasons. Think of it like decorating a delicious meal at a restaurant; even though the taste matters most, the presentation enhances the overall experience.
When it comes to coding standards, everyone has their own opinion. Some wonder if these rules and guidelines truly help us write better code. In my personal view, coding standards may not directly improve the functionality of our code, but
they play a crucial role in making our code look presentable and easy to understand. This is important for several reasons. Think of it like decorating a delicious meal at a restaurant; even though the taste matters most, the presentation
enhances the overall experience.

Coding standards are akin to a set of guidelines that instruct us on how to write our code neatly and consistently. While they might not make our code work better, they make it significantly easier to read and work with. Here are some key reasons why coding standards matter. Coding standards serve multiple essential purposes in software development. Firstly, they significantly enhance code readability, creating an experience similar to reading a well-structured book where everything makes sense, thereby easing bug fixes and troubleshooting. Secondly, in collaborative projects, adherence to coding standards ensures that everyone speaks the same coding language, promoting seamless understanding and teamwork among developers. Additionally, coding standards act as a shield against errors, offering clear rules for variable naming and code formatting, reducing the likelihood of small mistakes causing significant issues. Lastly, they serve as valuable learning tools, similar to following a recipe to master cooking, aiding in understanding programming languages' grammar and vocabulary, ultimately cultivating more skilled coders.
Coding standards are akin to a set of guidelines that instruct us on how to write our code neatly and consistently. While they might not make our code work better, they make it significantly easier to read and work with. Here are some key
reasons why coding standards matter. Coding standards serve multiple essential purposes in software development. Firstly, they significantly enhance code readability, creating an experience similar to reading a well-structured book where
everything makes sense, thereby easing bug fixes and troubleshooting. Secondly, in collaborative projects, adherence to coding standards ensures that everyone speaks the same coding language, promoting seamless understanding and teamwork
among developers. Additionally, coding standards act as a shield against errors, offering clear rules for variable naming and code formatting, reducing the likelihood of small mistakes causing significant issues. Lastly, they serve as
valuable learning tools, similar to following a recipe to master cooking, aiding in understanding programming languages' grammar and vocabulary, ultimately cultivating more skilled coders.

During my initial week of utilizing ESLint in collaboration with IntelliJ, I encountered a few challenges. ESLint functions as an assistant, verifying if your code aligns with the coding standards. When you achieve that green checkmark, it symbolizes that you are effectively following the rules. However, attaining this green checkmark can prove to be quite demanding. ESLint's strict nature, along with its somewhat tedious setup process, can be a bit of a frustration. Personally, I had mixed feelings about the setup since it involves downloading multiple files, which I found to be a bit tedious. Nevertheless, despite the setup inconveniences, the core purpose of ESLint as a valuable coding aid shines through, simplifying the coding process and enhancing code quality when used effectively.

Coding standards certainly have an indirect impact on code quality; though the code still runs, following coding standards makes it significantly easier to write the code and detect issues. It might help to insert a picture, perhaps of ESLint highlighting violations of our coding standards. We will go over a more convenient means of handling the sample.* files later in the semester.
<div style="display: flex; justify-content: center;">
<img width="600px" src="../img/ESlint.png" class="img-thumbnail" >
</div>


During my initial week of utilizing ESLint in collaboration with IntelliJ, I encountered a few challenges. ESLint functions as an assistant, verifying if your code aligns with the coding standards. When you achieve that green checkmark, it
symbolizes that you are effectively following the rules. However, attaining this green checkmark can prove to be quite demanding. ESLint's strict nature, along with its somewhat tedious setup process, can be a bit of a frustration.
Personally, I had mixed feelings about the setup since it involves downloading multiple files, which I found to be a bit tedious. Nevertheless, despite the setup inconveniences, the core purpose of ESLint as a valuable coding aid shines
through, simplifying the coding process and enhancing code quality when used effectively.

Coding standards certainly have an indirect impact on code quality; though the code still runs, following coding standards makes it significantly easier to write the code and detect issues. It might help to insert a picture, perhaps of
ESLint highlighting violations of our coding standards. We will go over a more convenient means of handling the sample.* files later in the semester.



Expand Down
3 changes: 3 additions & 0 deletions essays/DesignPatterns.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ labels:
- Software Engineering
- Learning
---
<div style="display: flex; justify-content: center;">
<img width="350px" src="../img/music.jpg" class="img-thumbnail" >
</div>

In my coding experiences, I envision each project as a musical piece, where every part harmonizes to create a beautiful composition. Design patterns, in this analogy, are akin to musical notes and arrangements that guide me in creating software that's not just functional but also fashionable. It's as if the code I create is a symphony, and these design patterns are the melodies ensuring everything fits together smoothly.

Expand Down
4 changes: 4 additions & 0 deletions essays/JavaScriptReflection.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ labels:
---

## JavaScript: A Newcomer's Adventure
<div>
<img width="200px" src="../img/java.png" class="img-thumbnail" >
JavaScript, to me, is more than just solving an engaging puzzle—it's a delightful challenge that seamlessly intertwines fun with complexity. Drawing from my experience with Java, C, and C++, stepping into the realm of JavaScript felt akin to meeting an old friend. Shared conventions, such as the use of curly braces, semicolons, and handling "Strings," bridged a comforting connection between the languages. Yet, even with a background in Java and C, the journey with JavaScript still unfolds with its fair share of intriguing errors.

Embracing JavaScript, a relatively new language in my repertoire, brings a profound sense of reassurance due to its striking similarities with Java and C. The shared structures, encompassing aspects like loops and if statements, provide a comforting continuity in my learning journey. As I delved into ICS 314, a captivating revelation surfaced—the introduction of ES6, an upgrade for JavaScript. This enhanced version brought with it fascinating additions like arrow functions, elevating the aesthetics of coding and making the script appear more refined. Additionally, the array manipulation capabilities introduced in ES6 opened doors to intriguing possibilities, allowing for the efficient extraction, addition, and replacement of values.
Expand All @@ -19,6 +21,8 @@ The practice Workouts of the Day (WODs) emerge as invaluable exercises in the do

In the grand scheme, JavaScript reveals itself as a treasure map—a source of excitement with occasional challenges, guiding us to create remarkable things on the web. Despite its nuances, we have an array of tools and helpful resources to assist us along this journey. As my coding knowledge continues to expand, I am confident that JavaScript will find a lasting and cherished place in my heart.

</div>




Expand Down
28 changes: 24 additions & 4 deletions essays/ReflectingOnSoftwateEngineering.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,34 @@ Throughout this software engineering class, I've gained insights that go beyond
### Collaborative Information
Open Source Software Development is all about teamwork and collective problem-solving. It's not just limited to web applications but extends to any project where shared knowledge and collaboration can drive innovation and efficiency.
### Configuration Management: Precision in System Changes
Configuration Management might sound complex, but it's essentially about handling changes to a system's components. This is relevant not only in web development but in any project, ensuring that changes are implemented smoothly without causing disruptions.
### Configuration Management: Precision in System Changes
Configuration Management might sound complex, but it's essentially about handling changes to a system's components.
This is relevant not only in web development but in any project, ensuring that changes are implemented smoothly
without causing disruptions. Understanding project management is equally paramount. Project Management provides
the framework for planning, executing, and overseeing the successful completion of a project. It involves
coordinating various elements, managing resources, and ensuring that the project aligns with its objectives.
Proficiency in both Configuration Management and project management is indispensable for delivering high-quality
software solutions on time and within budget.

<div>
<img width="350px" src="../img/M1.png" class="img-thumbnail" >
</div>

Agile Project Management, especially the Issue Driven Project Management style we learned, has applications beyond the web. Agile principles emphasize adaptability, teamwork, and iterative progress, making them valuable in managing different kinds of projects. Whether it's coding or non-coding, Agile can improve responsiveness, communication, and project timelines.



### Universal Importance in Software Engineering
Looking at the bigger picture of software engineering, certain principles are universally important. Coding Standards and Design Patterns, for example, are crucial regardless of the project type. Coding Standards make code consistent and readable, ensuring maintainability. Design Patterns provide proven solutions to common design problems, making solutions scalable and efficient in various contexts.
Looking at the bigger picture of software engineering, certain principles are universally important. Coding Standards, Design Patterns, and the incorporation of tools like ESLint are crucial regardless of the project type. Coding Standards make code consistent and readable, ensuring maintainability. Design Patterns provide proven solutions to common design problems, making solutions scalable and efficient in various contexts. ESLint, as a code analysis tool, significantly improves the development experience by enforcing coding standards and identifying potential issues early in the process.
### End of the Journey
Considering Ethics in Software Engineering is not just a box to tick but a vital consideration in any project. Ensuring responsible and ethical use of technology is crucial, preventing harm and promoting the positive impact of software engineering on society.

As I wrap up this course, I realize that what I've learned goes way beyond web development. It's about understanding collaboration, managing changes systematically, adapting to project needs, and always considering the ethical implications of our work. This foundation gives me the tools to navigate the diverse landscape of software engineering, showing how these fundamental concepts are applicable and adaptable in many different scenarios.
As I wrap up this course, I realize that what I've learned goes way beyond web development.
It's about understanding collaboration, managing changes systematically, adapting to project needs, and always
considering the ethical implications of our work. This foundation gives me the tools to navigate the diverse
landscape of software engineering, showing how these fundamental concepts are applicable and adaptable in many
different scenarios.
<div style="display: flex; justify-content: center;">
<img width="400px" src="../img/OIP.jpg" class="img-thumbnail" >
</div>


Binary file added img/ESlint.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/M1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/OIP.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/java.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/music.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 6cf0de9

Please sign in to comment.