Merge pull request #49 from riconeitzel/patch-1

Update how-to-contribute-to-the-magento-2-community.md

Author: DavidLambauer

how-to-contribute-to-the-magento-2-community.md

@@ -1,48 +1,48 @@
-# Contributing to the Magento 2 Community
+# Contributing to the Mage-OS Community
 
 [TOC]
 
 ## Introduction
 
-Thank you for your interest in contributing to the vibrant Magento 2 community! Your contributions can help improve the
+Thank you for your interest in contributing to the vibrant Mage-OS community! Your contributions can help improve the
 platform, fix bugs, develop new features, and enhance the overall user experience. This guide will walk you through the
-process of contributing to the Magento 2 community, covering everything from setting up your local development
+process of contributing to the Mage-OS community, covering everything from setting up your local development
 environment to submitting your contributions for review.
 
 ## Prerequisites
 
-Before you start contributing to the Magento 2 community, ensure that you have the following prerequisites in place:
+Before you start contributing to the Mage-OS community, ensure that you have the following prerequisites in place:
 
-1. **Magento 2 instance**: Set up a local development environment with a Magento 2 instance, preferably the latest
+1. **Mage-OS instance**: Set up a local development environment with a Mage-OS instance, preferably the latest
    stable version.
 2. **Git**: Install Git on your machine to help manage your code changes.
 3. **GitHub Account**: Create an account on GitHub if you don't already have one. This will enable you to contribute to
-   the Magento 2 repository.
+   the Mage-OS repository.
 
-## Clone the Magento 2 Repository
+## Clone the Mage-OS Repository
 
-To contribute to the Magento 2 community, you will need to clone the official Magento 2 repository onto your local
+To contribute to the Mage-OS community, you will need to clone the official Mage-OS repository onto your local
 machine. Follow these steps to get started:
 
-1. Open your command line interface and navigate to the directory where you want to clone the Magento 2 repository.
+1. Open your command line interface and navigate to the directory where you want to clone the Mage-OS repository.
 2. Run the following command to clone the repository:
 
 ```shell
-git clone https://github.com/magento/magento2.git
+git clone git@github.com:mage-os/mageos-magento2.git
 ```
 
-3. Once the cloning process completes, navigate into the `magento2` directory using the following command:
+3. Once the cloning process completes, navigate into the `mageos-magento2` directory using the following command:
 
 ```shell
-cd magento2
+cd mageos-magento2
 ```
 
 ## Creating a Branch
 
-Before you start making changes to the Magento 2 codebase, it's important to create a new branch for your contributions.
+Before you start making changes to the Mage-OS codebase, it's important to create a new branch for your contributions.
 This ensures that your changes are isolated and can be easily managed. Follow these steps to create a new branch:
 
-1. Ensure that you are in the `magento2` directory.
+1. Ensure that you are in the `mageos-magento2` directory.
 2. Run the following command to create a new branch:
 
 ```shell
@@ -62,7 +62,7 @@ are a few examples:
 If you want to fix a bug, follow these steps:
 
 1. Identify the bug you want to fix.
-2. Navigate to the relevant file(s) in the Magento 2 codebase.
+2. Navigate to the relevant file(s) in the Mage-OS codebase.
 3. Make the necessary changes to address the bug.
 4. Test your changes to ensure they fix the bug and do not introduce any regressions.
 
@@ -77,10 +77,10 @@ If you want to develop a new feature, follow these steps:
 
 ## Running Tests
 
-Before submitting your code changes for review, it is essential to run the tests provided by Magento 2 to ensure that
+Before submitting your code changes for review, it is essential to run the tests provided by Mage-OS to ensure that
 your changes do not introduce any regressions. Follow these steps to run the tests:
 
-1. Ensure that you are in the `magento2` directory.
+1. Ensure that you are in the `mageos-magento2` directory.
 2. Run the following command to install the necessary testing dependencies:
 
 ```shell
@@ -106,8 +106,8 @@ Follow these steps to create a pull request (PR) on GitHub:
 git push origin my-branch-name
 ```
 
-2. Visit the official Magento 2 repository on
-   GitHub: [https://github.com/magento/magento2](https://github.com/magento/magento2).
+2. Visit the official Mage-OS repository on
+   GitHub: [https://github.com/mage-os/mageos-magento2](https://github.com/mage-os/mageos-magento2).
 3. Click on the "Pull requests" tab.
 4. Click on the "New pull request" button.
 5. Select your branch from the dropdown menu.
@@ -116,7 +116,7 @@ git push origin my-branch-name
 
 ## Conclusion
 
-Contributing to the Magento 2 community is an excellent way to improve the platform and collaborate with other
-developers. By following the steps outlined in this guide, you can start making a positive impact on the Magento 2
+Contributing to the Mage-OS community is an excellent way to improve the platform and collaborate with other
+developers. By following the steps outlined in this guide, you can start making a positive impact on the Mage-OS
 ecosystem. Remember to always adhere to best practices, thoroughly test your changes, and actively engage with the
 community for feedback and guidance. Happy contributing!