Create a support repository for any general questions

[YuriDevAT]

I am thinking of creating a support repository which I often see in other Organizations as well. I would use this repository to store general information (which concerns all projects) like how to start with open source, how to fork a projects and such. These information is currently stored in every project on the read me.

[Muskan2404]

How to contribute?

This project aims to be a beginner friendly way to your first contribution to open source. If you are looking to make your first contribution, follow the steps below.

Also, read the Contribution Guide before interacting with the repositories.

Images are from the Dev CV repository of this organization.

‼️ To get more women and especially people with disabilities into tech, I always assign tickets to them first.

CodeNewbies

If you are a complete beginner in open source / GitHub, don't worry. Look at the following description on how to set up the project locally.

If you are a complete beginner in coding or open source, don't worry. Let's start with the following: Look up what semantic HTML means. Think about what a navigation actually is (a list of links). Use the corresponding semantic HTML for it. You can find everything needed to fulfill this issue by looking the terms up in w3schools or MDN. If these sites are new to you, don't worry. You will get used to them over time. Happy coding 🙂

Prerequisites

If you don't have git on your machine, install it.

Fork this repository

Fork this repository by clicking on the fork button on the top of this page.
This will create a copy of this repository in your account.

Clone the repository

Now clone the forked repository to your machine. Go to your GitHub account, open the forked repository, click on the code button and then click the copy to clipboard icon.

Open a terminal, go to the directory where you want the project to be saved and run the following git command:

git clone "url you just copied"

where "url you just copied" (without the quotation marks) is the url to this repository (your fork of this project). See the previous steps to obtain the url.

For example:

git clone https://github.com/this-is-you/dev-cv.git

where this-is-you is your GitHub username. Here you're copying the contents of the dev-cv repository on GitHub to your computer.

Create a branch

Change to the repository directory on your computer (if you are not already there):

cd dev-cv

Open the project in Visual Studio Code (or your favorite code editor):

code .

Run the project:

Right click on the index.html file and choose

Open with Live Server

Now create a branch using the git checkout -b command:

git checkout -b your-new-branch-name

For example:

git checkout -b name-of-issue

Make necessary changes and commit those changes

If you go to the project directory and execute the command git status, you'll see there are changes.

Add those changes to the branch you just created using the git add command:

git add filename

Now commit those changes using the git commit command:

git commit -m "Name of issue"

Commit message

There are different ways of writing a commit message. For more reference checkout the
article about How to write a good commit message.

For this project we are going to use following style:

type-of-issue- + number-of-issue[action you took]

Practical example:

feature-11[Fix typo in README.md]

Push changes to GitHub

Push your changes using the command git push:

git push origin -u <add-your-branch-name>

replacing <add-your-branch-name> with the name of the branch you created earlier.

Submit your changes for review

If you go to your repository on GitHub, you'll see a Compare & pull request button. Click on that button.

Now submit the pull request.

[Muskan2404]

Where to go from here?

Congrats! You just completed the standard fork -> clone -> edit -> pull request workflow that you'll encounter often as a contributor!

Celebrate your contribution and share it with your friends and followers on your social media accounts.

Now let's get you started with your next contribution, whether on this or any other great open source projects on GitHub.

[YuriDevAT]

Have fun 👻!