From 9151d0ab31ecd3c372485d6d29d9d92efa228bb4 Mon Sep 17 00:00:00 2001 From: Yehia Rasheed <157399068+yehiarasheed@users.noreply.github.com> Date: Wed, 9 Oct 2024 04:58:36 +0300 Subject: [PATCH 1/3] Create CONTRIBUTING.md Create a CONTRIBUTING.md file for the main branch, to be copied later to the gh-pages branch and referred to in the README.md file in the main branch. --- CONTRIBUTING.md | 82 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 82 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..6c73ee70 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,82 @@ +# Contributing to Awesome GitHub Profiles + +Thank you for your interest in contributing to the **Awesome GitHub Profiles** project! We appreciate your time and effort. Follow the steps below to contribute successfully. + +## Getting Started + +### 1. Fork the Repository + +Click the **Fork** button at the top right of the repository page. This creates a copy of the repository under your GitHub account. + +### 2. Clone Your Fork + +After forking, clone your repository to your local machine: + +```bash +git clone https://github.com/YOUR_USERNAME/awesome-github-profiles.git +``` + +Replace `YOUR_USERNAME` with your GitHub username. + +### 3. Switch to the `gh-pages` Branch + +Since the main code is in the `gh-pages` branch, navigate to that branch after cloning: + +```bash +cd awesome-github-profiles +git checkout gh-pages +``` + +### 4. Create a New Branch + +Create a new branch for your feature or bug fix: + +```bash +git checkout -b your-feature-branch +``` + +Use a descriptive name for your branch (e.g., `add-new-profile`, `fix-readme-typo`). + +### 5. Make Your Changes + +Make the necessary changes in your local repository. Follow the project's coding style and guidelines to ensure consistency. + +### 6. Test Your Changes + +If applicable, test your changes locally to ensure nothing breaks. This can include: + +- Running the project to verify functionality. +- Running tests if the project includes any testing tools. + +### 7. Stage and Commit Your Changes + +Once your changes are made, stage the files you want to commit: + +```bash +git add . +``` + +Commit your changes with a clear message: + +```bash +git commit -m "Add new profile" # Be specific about what changes were made. +``` + +### 8. Push to Your Fork + +Push your new branch to your forked repository: + +```bash +git push origin your-feature-branch +``` + +### 9. Submit a Pull Request (PR) + +Navigate to the original repository on GitHub, and you should see an option to create a Pull Request. Click that and fill in the necessary details: + +- Reference any issue your PR addresses (e.g., "Closes #123"). +- Explain clearly what your changes do. + +After submitting your PR, the maintainers will review it. You may receive feedback or requests for changes, so keep an eye on the comments. + +--- From 9ff91e7e0f60e6c33bbf7c9b0a52440f7ac30a47 Mon Sep 17 00:00:00 2001 From: Yehia Rasheed <157399068+yehiarasheed@users.noreply.github.com> Date: Wed, 9 Oct 2024 05:05:02 +0300 Subject: [PATCH 2/3] add link to CONTRIBUTING.md file Under the contribute section, I've added a hyperlink that links to the CONTRIBUTING.md file which users can check out if they need more detailed instructions. --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index a93b2a2b..ada45179 100644 --- a/README.md +++ b/README.md @@ -274,6 +274,7 @@ To ensure a smooth collaboration process, Follow these steps: 9. **Create a Pull Request:** - Navigate to the original repository where you want to propose your changes. - Click on "New Pull Request" and follow the instructions to submit your changes for review. +For even more detailed instructions on how to contribute, you can always check out the [CONTRIBUTING.md](./CONTRIBUTING.md) file.

Special Thanks 🙇

From 1cc265389584aebd39b95156a96a58121d542596 Mon Sep 17 00:00:00 2001 From: Yehia Rasheed <157399068+yehiarasheed@users.noreply.github.com> Date: Wed, 9 Oct 2024 05:07:39 +0300 Subject: [PATCH 3/3] add switch to gh-pages command --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ada45179..78b8614f 100644 --- a/README.md +++ b/README.md @@ -229,9 +229,10 @@ To ensure a smooth collaboration process, Follow these steps: 3. **Create a Branch:** - - Navigate into the cloned repository: + - Navigate into the cloned repository and switch to the `gh-pages` branch: ```bash cd awesome-github-profiles + git checkout gh-pages ``` - Create a new branch for your feature or fix: ```bash