Merge pull request #138 from kamranahmedse/master

Create a new pull request by comparing changes across two branches

Author: GulajavaMinistudio

contributing.md

@@ -2,40 +2,83 @@
 
 First of all thank you for considering to contribute. Please look at the details below:
 
-- [Contribution](#contribution)
-  - [New Roadmaps](#new-roadmaps)
-  - [Existing Roadmaps](#existing-roadmaps)
-  - [Adding Content](#adding-content)
-  - [Guidelines](#guidelines)
+- [New Roadmaps](#new-roadmaps)
+- [Existing Roadmaps](#existing-roadmaps)
+- [Adding Content](#adding-content)
+- [Guidelines](#guidelines)
 
 ## New Roadmaps
 
-For new roadmaps, submit a roadmap by providing [a textual roadmap similar to this roadmap](https://gist.github.com/kamranahmedse/98758d2c73799b3a6ce17385e4c548a5) in an issue.
+For new roadmaps, you can either:
+- Submit a roadmap by providing [a textual roadmap similar to this roadmap](https://gist.github.com/kamranahmedse/98758d2c73799b3a6ce17385e4c548a5) in an [issue](https://github.com/kamranahmedse/developer-roadmap/issues).
+- Create an interactive roadmap yourself using [our roadmap editor](https://draw.roadmap.sh/) & submit the link to that roadmap in an [issue](https://github.com/kamranahmedse/developer-roadmap/issues).
 
 ## Existing Roadmaps
 
 For the existing roadmaps, please follow the details listed for the nature of contribution:
 
-- **Fixing Typos** — Make your changes in the [roadmap JSON file](https://github.com/kamranahmedse/developer-roadmap/tree/master/src/data/roadmaps)
-- **Adding or Removing Nodes** — Please open an issue with your suggestion.
+- **Fixing Typos** — Make your changes in the [roadmap JSON file](https://github.com/kamranahmedse/developer-roadmap/tree/master/src/data/roadmaps) and submit a [PR](https://github.com/kamranahmedse/developer-roadmap/pulls).
+- **Adding or Removing Nodes** — Please open an [issue](https://github.com/kamranahmedse/developer-roadmap/issues) with your suggestion.
 
-**Note:** Please note that our goal is not to have the biggest list of items. Our goal is to list items or skills most relevant today.
+**Note:** Please note that our goal is <strong>not to have the biggest list of items</strong>. Our goal is to list items or skills most relevant today.
 
 ## Adding Content
 
 Find [the content directory inside the relevant roadmap](https://github.com/kamranahmedse/developer-roadmap/tree/master/src/data/roadmaps). Please keep the following guidelines in mind when submitting content:
 
 - Content must be in English.
-- Put a brief description about the topic on top of the file and the a list of links below with each link having title of the URL.
+- Maximum of 8 links per topic.
+- Follow the below style guide for content.
+
+### How To Structure Content
+
+Please adhere to the following style when adding content to a topic:
+
+```
+# Topic Title
+
+(Content)
+
+Visit the following resources to learn more:
+
+- [Description of link](Link)
+```
 
 ## Guidelines
 
 - <p><strong>Adding everything available out there is not the goal!</strong><br />
-  The roadmaps represent the skillset most valuable today, i.e., if you were to enter any of the listed fields today, what would you learn?! There might be things that are of-course being used today but prioritize the things that are most in demand today, e.g., agreed that lots of people are using angular.js today but you wouldn't want to learn that instead of React, Angular, or Vue. Use your critical thinking to filter out non-essential stuff. Give honest arguments for why the resource should be included.</p>
+
+  The roadmaps represent the skillset most valuable today, i.e., if you were to enter any of the listed fields today, what would you learn? There might be things that are of-course being used today but prioritize the things that are most in demand today, e.g., agreed that lots of people are using angular.js today but you wouldn't want to learn that instead of React, Angular, or Vue. Use your critical thinking to filter out non-essential stuff. Give honest arguments for why the resource should be included.</p>
+
 - <p><strong>Do not add things you have not evaluated personally!</strong><br />
+
   Use your critical thinking to filter out non-essential stuff. Give honest arguments for why the resource should be included. Have you read this book? Can you give a short article?</p>
+
 - <p><strong>Create a Single PR for Content Additions</strong></p>
 
   If you are planning to contribute by adding content to the roadmaps, I recommend you to clone the repository, add content to the [content directory of the roadmap](./src/data/roadmaps/) and create a single PR to make it easier for me to review and merge the PR.
-- Write meaningful commit messages
-- Look at the existing issues/pull requests before opening new ones
+
+- <p><strong>Write meaningful commit messages</strong><br >
+
+  Meaningful commit messages help speed up the review process as well as help other contributors in gaining a good overview of the repositories commit history without having to dive into every commit.
+  
+  (See the following guide on how to write good [commit messages](https://www.freecodecamp.org/news/how-to-write-better-git-commit-messages/)).
+
+  </p>
+- <p><strong>Look at the existing issues/pull requests before opening new ones</strong></p>
+
+### Good vs Not So Good Contributions
+
+<strong>Good</strong>
+
+  - New Roadmaps.
+  - Engaging, fresh content links.
+  - Typos and grammatical fixes.
+  - Content copy in topics that do not have any (or minimal copy exists).
+
+<strong>Not So Good</strong>
+
+  - Adding whitespace that doesn't add to the readability of the content.
+  - Rewriting content in a way that doesn't add any value.
+  - None English content.
+  - PR's that don't follow our style guide, have no description and a default title.

src/components/Roadmaps/RoadmapsPage.tsx

@@ -229,12 +229,12 @@ const groups: GroupType[] = [
       {
         title: 'React Native',
         link: '/react-native',
-        type: 'role',
+        type: 'skill',
       },
       {
         title: 'Flutter',
         link: '/flutter',
-        type: 'role',
+        type: 'skill',
       },
     ],
   },

src/data/roadmaps/angular/content/100-typescript-basics/101-why-use-typescript.md

@@ -3,7 +3,7 @@
 TypeScript extends JavaScript, providing a better developer experience. The benefits of using TypeScript over JavaScript include:
 - **Static typing** – TypeScript comes with optional static typing and a type inference system, which means that a variable declared with no type may be inferred by TypeScript based on its value.
 - **Object-oriented programming** – TypeScript supports object-oriented programming concepts like classes, inheritance, etc.
-- **ompile time checks** – JavaScript is an interpreted programming language. There is no compilation involved. Hence, the errors get caught during the runtime. Since TypeScript compiles into JavaScript, errors get reported during the compile time rather than the runtime.
+- **Compile time checks** – JavaScript is an interpreted programming language. There is no compilation involved. Hence, the errors get caught during the runtime. Since TypeScript compiles into JavaScript, errors get reported during the compile time rather than the runtime.
 - **Code editor support** – IDEs or code editors like VS Code support autocomplete for a TypeScript codebase. They also provide inline documentation and highlight the errors.
 - **Integration with existing JavaScript Packages** – You might want to use an npm package written in JavaScript. Since TypeScript is a superset of JavaScript, you can import and use that package. Moreover, the TypeScript community creates and maintains type definitions for popular packages that can be utilized in your project.
 

src/data/roadmaps/datastructures-and-algorithms/content/103-basic-data-structures/101-linked-lists.md

@@ -1,3 +1,8 @@
 # Linked Lists
 
-Linked Lists are a type of data structure used for storing collections of data. The data is stored in nodes, each of which contains a data field and a reference (link) to the next node in the sequence. Structurally, a linked list is organized into a sequence or chain of nodes, hence the name. Two types of linked lists are commonly used: singly linked lists, where each node points to the next node and the last node points to null, and doubly linked lists, where each node has two links, one to the previous node and another one to the next. Linked Lists are used in other types of data structures like stacks and queues.
+Linked Lists are a type of data structure used for storing collections of data. The data is stored in nodes, each of which contains a data field and a reference (link) to the next node in the sequence. Structurally, a linked list is organized into a sequence or chain of nodes, hence the name. Two types of linked lists are commonly used: singly linked lists, where each node points to the next node and the last node points to null, and doubly linked lists, where each node has two links, one to the previous node and another one to the next. Linked Lists are used in other types of data structures like stacks and queues.
+
+Learn more from the following links:
+
+- [Linked List Explained: from Basics to Advanced](https://www.freecodecamp.org/news/how-linked-lists-work/)
+- [Introduction To Linked List](https://youtu.be/Nq7ok-OyEpg?si=xttaGoYKcoJ09Ln2)

src/data/roadmaps/devops/content/118-artifcats/index.md

@@ -1 +1 @@
-# Artifcats
+# Artifacts

src/data/roadmaps/flutter/flutter.md

@@ -53,5 +53,5 @@ sitemap:
 tags:
   - 'roadmap'
   - 'main-sitemap'
-  - 'role-roadmap'
+  - 'skill-roadmap'
 ---

src/data/roadmaps/nodejs/content/110-nodejs-databases/101-document/101-prisma.md

@@ -1,6 +1,6 @@
 # Prisma
 
-Prisma is an open source next-generation ORM in the TypeScript ecosystem. It offer a dedicated API for relation filters. It provide an abstraction layer that makes you more productive compared to writing SQL. Prisma currently supports `PostgreSQL`, `MySQL`, `SQL Server`, `SQLite`, `MongoDB` and `CockroachDB`.
+Prisma provides an open source next-generation ORM in the TypeScript ecosystem. It offers a dedicated API for relation filters. It provides an abstraction layer that makes you more productive compared to writing SQL. Prisma currently supports `PostgreSQL`, `MySQL`, `SQL Server`, `SQLite`, `MongoDB` and `CockroachDB`.
 
 Visit the following resources to learn more:
 

src/data/roadmaps/python/content/105-python-package-managers/103-poetry.md

@@ -0,0 +1,9 @@
+# Poetry
+
+Poetry is a dependency management and packaging tool for Python that runs on Windows, macOS, and Linux. Poetry efficiently installs, manages, and updates packages and their dependencies. Poetry seamlessly creates, saves, loads, and switches between project environments on your local computer. It is designed specifically for Python projects, providing a streamlined workflow for managing dependencies, virtual environments, and building packages.
+
+Poetry as a package manager helps you find and install packages. If you need a specific version of a package or a different version of Python, Poetry handles both dependency management and virtual environments effortlessly. With just a few commands, you can set up a completely isolated environment to run a different version of Python or package configuration, while maintaining your usual development environment. Poetry’s lock file ensures consistent installs across different environments, enhancing reproducibility and stability of your projects.
+
+Visit the following resources to learn more:
+
+- [Poetry Docs](https://python-poetry.org/docs/)

src/data/roadmaps/python/content/105-python-package-managers/index.md

@@ -4,5 +4,4 @@ Package managers allow you to manage the dependencies (external code written by
 
 `PyPI` and `Pip` are the most common contenders but here are some other options available as well:
 
-- [**Poetry**](https://python-poetry.org/) : Manages dependencies via isolation
 - [**PIPX**](https://github.com/pypa/pipx) : Isolation-based app deployment, so you don't have to affect the system or user PIP libraries. It enables you to try individual python CLI tools without affecting other dependencies.