Skip to content

Commit 8b9c056

Browse files
Rajkumar-justcoderRajkumar-justcoder
committed
Fix : updated readme.md, added contributing.md
1 parent 2074665 commit 8b9c056

File tree

6 files changed

+302
-112
lines changed

6 files changed

+302
-112
lines changed

‎.github/pull_request_template.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@
66

77
(Write your answer here.)
88

9+
## Class Naming Convention for your button
10+
- [ ] Does your html `button` element have class-name like this: `your_github_username-button-index` (example: `rajkumar-justcoder-button-1` ).
11+
912
## Checklist
1013

1114
- [ ] I've read the contribution guidelines.
@@ -16,3 +19,7 @@
1619
## Related Issues
1720

1821
Fixes Issue # (write number after `#`)
22+
23+
24+
## Screenshot
25+
( Add your button screenshot here.)

‎CONTRIBUTING.md

Lines changed: 191 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,191 @@
1+
# Contributing
2+
3+
Glad to see you want to contribute to this project!
4+
5+
> **Note**
6+
>
7+
> - We donot expect Modified CSS button of existing button.
8+
>
9+
> - Avoid duplicate contributions, please check if a project exists before contributing.
10+
11+
## Contents
12+
13+
- [Setup this project](#setup-project)
14+
- [Rules to follow when contributing](#some-rules-to-follow-when-contributing)
15+
- [Add your button to this repo](#add-your-button-to-css-buttons)
16+
- [How to ask help?](#where-can-i-go-for-help)
17+
- [Report a bug/feature request](#report-a-bugrequest-a-feature)
18+
19+
---
20+
21+
## Setup Project
22+
23+
To start contributing, follow the below guidelines:
24+
25+
1. Fork [this](https://github.com/Design-and-Code/css-buttons) repository.
26+
27+
2. Clone your forked copy of the project.
28+
29+
```
30+
git clone https://github.com/<your_username>/css-buttons.git
31+
```
32+
33+
3. Navigate to the directory `css-buttons` .
34+
35+
```
36+
cd css-buttons
37+
```
38+
39+
4. Add a reference (remote) to the original repository.
40+
41+
```
42+
git remote add upstream https://github.com/Design-and-Code/css-buttons.git
43+
```
44+
45+
5. Check the remotes for this repository.
46+
47+
```
48+
git remote -v
49+
```
50+
51+
6. Always take a pull from the upstream repository to your main branch to keep it up to date with the main project (updated repository).
52+
53+
```
54+
git pull upstream main
55+
```
56+
57+
7. Create a new branch.
58+
59+
```
60+
git checkout -b <your_branch_name>
61+
```
62+
63+
# Some rules to follow when Contributing:
64+
65+
- Please follow naming convention for button classes. (Eg. yourname-btn-index aka rajkumar-btn-1)
66+
- Do not change default buttons maked with the ` button-def ` class.
67+
- Do not change any code in the `index.html` file except for button section.
68+
- Do not change any code in the `assets` folder.
69+
70+
71+
## Add your button to css-buttons
72+
73+
> **Note**
74+
>
75+
> Run the following commands on the Terminal. <br>
76+
> If you are on **Windows**, run the commands on **Git Bash** terminal 📝
77+
>
78+
> ([read this to understand](#note-about-this-project))
79+
80+
1. Add your HTML code in the [index.html](https://github.com/Design-and-Code/css-buttons/blob/main/index.html) file.
81+
2. Add your CSS code in the [buttons.css](https://github.com/Design-and-Code/css-buttons/blob/main/buttons/buttons.css) file.
82+
3. Make sure you do not change any other button's code.
83+
4. For naming css classes use the correct naming conventions - eg. yourname-btn-index or btn-yourname-index.
84+
5. When you open the PR, please include a full screenshot.
85+
6. See below demo code to know how to add your button.
86+
87+
#### Demo code
88+
```html
89+
<!-- your-github-username-btn-1 start -->
90+
<div class="button-container">
91+
<!-- add your buttons here, eg.-->
92+
<button class="{your-github-username-btn-index}">
93+
<span class="{your-github-username-btn-index}"> Example Button </span>
94+
</button>
95+
<div class="createdby-section">
96+
Created by
97+
<a href="{your-github-link}">{your-github-username}</a>
98+
</div>
99+
</div>
100+
<!-- your-github-username-btn-1 end -->
101+
```
102+
> So it will look like this
103+
```html
104+
<!-- Rajkumar-justcoder-btn-1 start -->
105+
<div class="button-container">
106+
<!-- add your buttons here, eg.-->
107+
<button class="rajkumar-justcoder-btn-1">
108+
<span class="rajkumar-justcoder-btn-1-span"> Example Button </span>
109+
</button>
110+
<div class="createdby-section">
111+
Created by
112+
<a href="link">Rajkumar-justcoder</a>
113+
</div>
114+
</div>
115+
<!-- Rajkumar-justcoder-btn-1 end -->
116+
117+
```
118+
7. Also if u use any tag like span or div etc then your should have class-name like this: `your_github_username-btn-index-span/text/div` (example: `rajkumar-justcoder-btn-1-span`) as u can see in above given demo code.
119+
8. If using keyframes/animation in css then keyframe name also should be like this: `your_github_username-btn-index-rotate` (example: `rajkumar-justcoder-btn-1-rotate`)
120+
121+
122+
## Push your changes and make a Pull Request
123+
124+
1. Track your changes ✔.
125+
126+
```
127+
git add .
128+
```
129+
130+
2. Commit your changes.
131+
132+
```
133+
git commit -m "Relevant message"
134+
```
135+
136+
3. Push the committed changes in your feature branch to your remote repo.
137+
138+
```
139+
git push -u origin <your_branch_name>
140+
```
141+
142+
4. To create a pull request, click on `Compare & pull requests`.
143+
144+
5. Add appropriate title and description to your pull request explaining your changes and efforts done.
145+
146+
6. Click on `Create pull request`.
147+
148+
7. Voilà! You have made a PR to css-buttons 💥. Wait for your submission to be accepted and your PR to be merged.
149+
150+
151+
## Where can I go for help?
152+
153+
If you need help, you can join our discord server.
154+
155+
<p>
156+
<a href="https://discord.gg/druweDMn3s">
157+
<img alt="Discord" src="https://img.shields.io/badge/Discord-7289DA?style=for-the-badge&logo=discord&logoColor=white">
158+
</a>
159+
</p>
160+
161+
## Report a bug/request a feature
162+
163+
If you find a security vulnerability, do NOT open an issue. [Email](mailto:designandcode.community@gmail.com) us instead.
164+
165+
If you find yourself wishing for a feature that doesn't exist in css-buttons, you are probably not alone. Open an issue on our issues list on GitHub which describes
166+
the feature you would like to see, why you need it, and how it should work.
167+
168+
#### Follow these steps to report a bug/request a feature
169+
170+
- Head over to [issues](https://github.com/Design-and-Code/css-buttons/issues) tab.
171+
- Click on `New issue` in top right corner.
172+
- Add appropriate title and description to your issue.
173+
174+
175+
#### Things to keep in mind while reporting a bug
176+
177+
A good bug report shouldn't leave others needing to chase you up for more information.
178+
Please try to be as detailed as possible in your report.
179+
180+
- What is your environment?
181+
- What steps will reproduce the issue?
182+
- What browser(s) and OS experience the problem?
183+
- What would you expect to be the outcome?
184+
- Provide adequate screenshots/log for the bug.
185+
186+
All these details will help developers to fix any potential bugs.
187+
188+
#### Things to keep in mind while creating a feature request
189+
190+
Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of the project.
191+
It's up to you to make a strong case to convince the project's developers of the merits of this feature. Please provide as much detail and context as possible.

‎README.md

Lines changed: 7 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -16,26 +16,13 @@
1616
- Do not change any code in the `index.html` file except for button section.
1717
- Do not change any code in the `assets` folder.
1818

19-
# How to contribute by adding more buttons
20-
21-
1. Fork the repo and clone it.
22-
2. Add your HTML code in the [index.html](https://github.com/Design-and-Code/css-buttons/blob/main/index.html) file.
23-
3. Add your CSS code in the [buttons.css](https://github.com/Design-and-Code/css-buttons/blob/main/buttons/buttons.css) file.
24-
4. Make sure you do not change any other button's code.
25-
5. For naming css classes use the correct naming conventions - eg. yourname-btn-index or btn-yourname-index.
26-
6. When you open the PR, please include a full screenshot.
27-
28-
#### Demo code
29-
```html
30-
<div class="button-container">
31-
<!-- add your buttons here, eg.-->
32-
<button class="{yourname-button-index}"><span> Example Button </span></button>
33-
<div class="createdby-section">
34-
Created by
35-
<a href="{yourgithublink}">{YOURNAME}</a>
36-
</div>
37-
</div>
38-
```
19+
20+
## Contribution Guidelines 🏗
21+
22+
Want to add your inputs to the repo? We invite you to contribute.
23+
24+
Head to [CONTRIBUTING.md](./CONTRIBUTING.md) to start contributing.
25+
3926

4027
### Folder Structure
4128

‎assets/css/style.css

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
--forground-main-color: rgb(255 255 255 / 1);
1111
--background-main-color: rgb(0, 0, 0);
1212
--card-border-radius: 30px;
13-
--default-color:rgba(156, 163, 175);
13+
--default-color: rgba(156, 163, 175);
1414
--link-hover-color: rgb(129 120 255 / 1);
1515
--default-link-color: rgb(129 120 255 / 1);
1616
}
@@ -107,7 +107,7 @@ a {
107107

108108

109109
/* footer stat here */
110-
.footer-main{
110+
.footer-main {
111111
margin-top: 2rem;
112112
}
113113

@@ -206,7 +206,7 @@ a {
206206
.socials-span>a:hover {
207207
color: var(--link-hover-color);
208208
transform: scale(1.4);
209-
transition: all 0.3s ease-in-out;
209+
transition: all 0.3s ease-in-out;
210210
}
211211

212212
.socials-span>a:not(:first-child) {

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy