Open Source Project

Open Source Project Contribution Guideline

Git

Git is a free and open source distributed version control system designed to handle everything from small to very large projects with speed and efficiency. It outclasses SCM tools like Subversion, CVS, Perforce, and ClearCase with features like cheap local branching, convenient staging areas, and multiple workflows.

How to install Git & SetUp GitLab

These are the steps:

Step 1: Visit - GitLab
Step 2: Download the latest release for your system
Step 3: Install the package with default settings
Step 4: Got to Git Bash or cmd and type:
git --version

Step 5: Set GitLab username and email to the Git as a Global user.name and user.email:

Go to Git Bash or cmd and type:
git config --global user.name "username"

Here the username of GitLab after that press ENTER as well as repeat the process for email:
git config --global user.email "email"

Here the email of your GitLab account.

Fork a Project

1. You need to go to the project repository GitLab

2. At the top right you see the Fork icon

3. Click the icon which help to fork the project

4. Navigate to Your Git Repository: After forking the project you need to create a clone repository on you local system. Here is the correct syntax for cloning a Git repository is:

git clone https://gitlab.com/likhaa-contribution/likhaa.com.git

Here, the url of the repository of your fork repository. Make sure there are no extraneous characters or line breaks when you copy and paste the command into your terminal.

5. Change into the directory of the cloned repository:

cd likhaa.com

6. Check for .git Directory: Ensure that the directory you are in contains a .git directory, which signifies it is a Git repository. You can list all files including hidden ones using:

ls -a

7. Create a New Branch: Once you are in the correct directory, create a new branch with:

git checkout -b feature-branch

Summary of Step-by-Step Workflow:

Clone the Repository
Navigate into the Repository Directory
Create a New Branch
Check Current Directory: Verify that you are in the correct directory by running pwd to print the working directory. It should point to the root of your cloned repository.
Check Git Status: Run git status to check the status of the repository. This can give you more context if there are any issues.

Time to do the first task!

1. Navigate to Your Git Repository

If you haven't already, clone the repository and navigate to it:

git clone https://gitlab.com/likhaa-contribution/likhaa.com.git cd likhaa.com

2. Open the package.json File

Use a text editor to open the package.json file. You can use editors like nano, vim, code (for VSCode), or any GUI text editor.
nano package.json

3. Add Your Name to the Authors List:

Locate the "author" field or the "contributors" field in the package.json file. If it’s not there, you can add it. Here’s an example of how it might look:
{ "name": "likhaa.com", "version": "1.0.0", "description": "A No-Nonsense Online Whiteboard with handy shortcuts to quickly", "private": true, "scripts": { "dev": "webpack serve --open --mode=development --port=3101", "build": "webpack --mode=production" }, "keywords": [], "authors": ["Neetish Raj", "http406"], **Changes here** "license": "MIT", "devDependencies": { "copy-webpack-plugin": "^11.0.0", "css-loader": "^6.8.1", "html-webpack-plugin": "^5.5.3", "style-loader": "^3.3.3", "webpack": "^5.88.2", "webpack-cli": "^5.1.4", "webpack-dev-server": "^4.15.1" } }

4. Staging Changes:

Now you need to add your modified package.json to the repository:
git add package.json

5. Committing Changes:

Now you need to commit your changes with a proper description and mentioning what you change actually:
git commit -m "Add authors Neetish Raj and http406 to package.json"

6. Pushing Changes:

Push the changes to your remote repository:
git push origin feature-branch

7. Create a Merge Request

Go to your forked repository on GitLab and create a new Merge request. Choose the branch that contains your changes (feature-branch) as the source branch and the main branch of the upstream repository as the target branch. Someone with write access to the main repository will review your pull request. They may provide feedback or ask for changes. Once the changes are approved, they will merge your pull request into the main repository.

Project Guideline