ProCheck is an interactive checklist for your projects showcased in your portfolio. With ProCheck users can make sure to not forget necessary changes and improvements to make their projects stand out.
I've been asked any times when I started looking for a job, when I thought I was "ready". Checking each of this checkboxes was a great way to make sure I was ready to apply for a job.
Read more about Am I Ready To Apply For Jobs.
Note: Merge reviews are done every Saturday. 😇
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.
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.
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 by clicking on the fork button on the top of this page. This will create a copy of this repository in your account.
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 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/pro-check.git
where this-is-you is your GitHub username. Here you're copying the contents of the pro-check repository on GitHub to your computer.
Change to the repository directory on your computer (if you are not already there):
cd pro-check
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
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 "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 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.
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.
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 👻!