Top contributors

About DevCV

I got many great responses on my article about How To Write A Promising CV - thank you for that.

I've been asked many times which tool is the best to create a CV like mine - easily and for free. So I thought, why not develop our own tool? Together, open source, as part of Hacktoberfest 2022?

Read more about the project in the project's wiki.

Note: Merge reviews are done every Saturday. 😇

Design of the app

Please go to the discussions section of the project where I opened a discussion about the app's design and work together on a great design for the app.

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.

Prerequisites

If you don't have git on your machine, install it. If you don't have node 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 .

Install the dependencies:

npm install

Run the project:

npm start

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.

Soon I'll be merging all your changes into the master branch of this project. You will get a notification email once the changes have been merged.

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, wether on this or any other great open source projects on GitHub.

Have fun 👻!