Skip to content

Latest commit

 

History

History
99 lines (70 loc) · 2.95 KB

README.md

File metadata and controls

99 lines (70 loc) · 2.95 KB
Raw

Welcome🙏🏼 to the Website repo of devXsphere.

📚 Step-by-Step Contribution Guide

Follow these simple steps to make your first contribution:

1️⃣ Fork the Repository

First, fork this repository. Once done, you'll be redirected to your GitHub account where you'll have your own copy of the repo.

2️⃣ Clone Your Forked Repository

In your terminal, clone the repository to your local machine:

git clone https://github.com/<your-username>/Website-devxsphere.git

3️⃣ Navigate into the Directory

Move into the cloned directory:

cd Website-devxsphere

4️⃣ Set the Upstream URL

Before making any changes, set the upstream URL:

git remote add upstream https://github.com/DevXsphere/Website-devxsphere.git

# As a best practice, pull the latest changes before creating a new branch:
git pull upstream main --rebase

5️⃣ Create a New Branch

To avoid conflicts and follow best practices, create a new branch for your contribution:

# Replace <branch_name> with a meaningful name, e.g., add-feature, fix-issue.
git branch <branch_name>
git checkout <branch_name>

For more details on upstream, origin, and GitHub best practices, check out these helpful resources:

⚠️ IMPORTANT: Always make separate branches for each task and create PRs using those branches. Keeping the main branch clean is a great practice.

📂 Adding Your Contribution

  • Step 1: Make a directory with a meaningful name: 
    mkdir <Dir_name>
  • Step 2: Add your code, scripts, or project to the newly created directory.

🚀 Creating a Pull Request (PR)

Once you've made changes, follow these steps to create a PR:

  1. Stage your changes:

    git add .

  2. Commit your changes with a meaningful message:

    git commit -m "Add: <description of changes>"

  3. Push your branch to your GitHub repository:

    git push origin <branch_name>

  4. Open a Pull Request:

    • Navigate to your GitHub fork.
    • Click on the "Compare and Pull Request" button.
    • Provide a detailed description of your changes and submit your PR!

🎉 That's it! You’ve successfully created a pull request! 🥳

Once your PR is reviewed and merged, your contribution will be added to the repository. We're looking forward to your PR!

📈 Contributors

Thanks to all the wonderful contributors who have helped make this repository better! 🙌

We will do our best to merge as much as possible from everyone. However, time is limited and the merge conflicts are horrible 😲 <3