Skip to content

Commit 9c51468

Browse files
authored
Create CONTRIBUTING.md
1 parent 4cef07a commit 9c51468

File tree

1 file changed

+99
-0
lines changed

1 file changed

+99
-0
lines changed

CONTRIBUTING.md

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
# Contributing to CSS-Is-Fun
2+
3+
We appreciate your interest in contributing to CSS-Is-Fun! This document outlines the steps and guidelines for contributing to this project. By following these steps, you can ensure your contribution is smoothly integrated into the project.
4+
5+
## Table of Contents
6+
7+
- [Prerequisites](#prerequisites)
8+
- [Fork the Repository](#fork-the-repository)
9+
- [Clone the Repository](#clone-the-repository)
10+
- [Create a New Branch](#create-a-new-branch)
11+
- [Make Changes](#make-changes)
12+
- [Commit Your Changes](#commit-your-changes)
13+
- [Push to Your Fork](#push-to-your-fork)
14+
- [Submit a Pull Request](#submit-a-pull-request)
15+
- [Code Review](#code-review)
16+
17+
## Prerequisites
18+
19+
Before you start contributing, make sure you have the following tools installed on your local machine:
20+
21+
- [Git](https://git-scm.com/downloads)
22+
- A code editor of your choice, such as [Visual Studio Code](https://code.visualstudio.com/download), [Atom](https://atom.io/), or [Sublime Text](https://www.sublimetext.com/3).
23+
24+
## Fork the Repository
25+
26+
1. Navigate to the [CSS-Is-Fun GitHub repository](https://github.com/Deveesh-Shetty/CSS-Is-Fun).
27+
2. Click the "Fork" button in the top-right corner of the page to create a copy of the repository in your GitHub account.
28+
29+
## Clone the Repository
30+
31+
1. Open a terminal/command prompt on your local machine.
32+
2. Navigate to the directory where you want to clone the repository.
33+
3. Run the following command:
34+
35+
git clone https://github.com/YOUR_USERNAME/CSS-Is-Fun.git
36+
37+
Replace `YOUR_USERNAME` with your GitHub username.
38+
39+
## Create a New Branch
40+
41+
1. Navigate to the cloned repository on your local machine:
42+
43+
```bash
44+
cd CSS-Is-Fun
45+
```
46+
47+
2. Create a new branch using the following command:
48+
49+
```git
50+
git checkout -b your-new-branch-name
51+
```
52+
53+
Replace `your-new-branch-name` with a descriptive name for your branch, such as `add-new-feature`.
54+
55+
## Make Changes
56+
57+
1. Open the project in your preferred code editor.
58+
2. Make the necessary changes to the project. This could include adding new features, fixing bugs, or improving existing code.
59+
3. Test your changes to ensure they work correctly and do not introduce new bugs.
60+
61+
## Commit Your Changes
62+
63+
1. Stage the changes you made:
64+
65+
```git
66+
git add .
67+
```
68+
69+
2. Commit the changes with a descriptive commit message:
70+
71+
```git
72+
git commit -m "Your commit message here"
73+
```
74+
75+
Replace `Your commit message here` with a brief description of the changes you made.
76+
77+
## Push to Your Fork
78+
79+
1. Push your changes to your forked repository on GitHub:
80+
81+
```git
82+
git push origin your-new-branch-name
83+
```
84+
85+
Replace `your-new-branch-name` with the name of your branch.
86+
87+
## Submit a Pull Request
88+
89+
1. Navigate to the [CSS-Is-Fun GitHub repository](https://github.com/Deveesh-Shetty/CSS-Is-Fun).
90+
2. Click the "New pull request" button.
91+
3. Click "compare across forks" and select your forked repository and branch from the dropdown menus.
92+
4. Review the changes and click "Create pull request."
93+
5. Add a descriptive title and any additional comments, then click "Create pull request" again.
94+
95+
## Code Review
96+
97+
Once you have submitted your pull request, the project maintainer(s) will review your changes. They may provide feedback and request changes before merging your contribution. Be sure to address their feedback and make any necessary changes to ensure a smooth integration into the project.
98+
99+
Thank you for your contribution! 🚀

0 commit comments

Comments
 (0)