Skip to content

Commit f0dc07c

Browse files
Merge pull request #21 from CodingAce123/hacktoberfest
💥 Hacktoberfest 2021: Updated Contributing.md + Added README Badges
2 parents 8f1e64d + 816ecab commit f0dc07c

File tree

2 files changed

+92
-13
lines changed

2 files changed

+92
-13
lines changed

Contributing.md

+55-1
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,60 @@ contributors in other timezones have time to review. Consideration should also b
3838
weekends and other holiday periods to ensure active committers all have reasonable time to
3939
become involved in the discussion and review process if they wish.
4040

41+
## 🎉Contributing Guidelines 📝
42+
- Thanks a Ton for Showing your Interest in Contributing to our Repository! Pull requests are Welcome. For Major Changes, Please Open an Issue first to Discuss What you Would Like to Change.
43+
44+
- To Start Contributing to this Repository, Follow the Below Guidelines:-
45+
46+
1. **Fork this Repository.**
47+
48+
2. **Clone your Forked Copy of The Project.**
49+
```
50+
git clone https://github.com/<your_user_name>/solverjs.git
51+
```
52+
53+
3. **Navigate to the Project Directory 📁.**
54+
```
55+
cd solverjs
56+
```
57+
4. **Add Reference to Original Repository (remote).**
58+
```
59+
git remote add upstream https://github.com/suryapratapsinghsuryavanshi/solverjs.git
60+
```
61+
5. **Before Making any Changes in the Repository, Always Take a Pull from the Upstream Repository to Your Branch to Keep it Updated with The Remote Repository.**
62+
```
63+
git pull upstream main
64+
```
65+
6. **Create a New Branch**.
66+
```
67+
git checkout -b <your_branch_name>
68+
```
69+
7. **Make Necessary Changes that are Required.**
70+
71+
8. **Track Your Changes**
72+
```
73+
git add .
74+
```
75+
9. **Commit your Changes.**
76+
```
77+
git commit -m "Relevant message"
78+
```
79+
10. **Push the Commited Changes in Your Branch to Your Remote Repo.**
80+
```
81+
git push -u origin <your_branch_name>
82+
```
83+
11. **Make The Pull Request (PR)** 🚀
84+
12. Wooohoo! You have Successfully Made a PR to the Repo- solverjs 💥. Wait for your Submission to be Accepted and your PR to be Merged!.
85+
86+
<br/>
87+
<hr />
88+
89+
## ✨Our Contributors!-
90+
91+
<a href="https://github.com/suryapratapsinghsuryavanshi/solverjs">
92+
<img src="https://contrib.rocks/image?repo=suryapratapsinghsuryavanshi/solverjs" />
93+
</a>
94+
4195
## Becoming a Triager
4296
[Open an issue in `solverjs` repo](https://github.com/suryapratapsinghsuryavanshi/solverjs/issues/new)
4397
to request the triage role. State that you have read and agree to the
@@ -50,4 +104,4 @@ All contributors who land a non-trivial contribution should be on-boarded in a t
50104
and added as a committer, and be given write access to the repository.
51105
52106
Committers are expected to follow this policy and continue to send pull requests, go through
53-
proper review, and have other committers merge their pull requests.
107+
proper review, and have other committers merge their pull requests.

README.md

+37-12
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,50 @@
1-
[![SolverJs Logo](https://localprofiler.ml/uploads/file_1622214512395.png)](https://www.npmjs.com/package/solverjs/)
1+
<div align="center">
22

3+
[![SolverJs Logo](https://localprofiler.ml/uploads/file_1622214512395.png)](https://www.npmjs.com/package/solverjs/)
4+
</div>
35

4-
[![NPM Version][npm-image]][npm-url]
5-
[![NPM Downloads][downloads-image]][downloads-url]
6-
[![Linux Build][travis-image]][travis-url]
7-
[![Windows Build][appveyor-image]][appveyor-url]
8-
[![Test Coverage][coveralls-image]][coveralls-url]
9-
[![](https://tokei.rs/b1/github/suryapratapsinghsuryavanshi/solverjs)](https://github.com/suryapratapsinghsuryavanshi/solverjs)
6+
<div align="center">
7+
8+
[![GitHub forks](https://img.shields.io/github/forks/suryapratapsinghsuryavanshi/solverjs.svg?style=social&label=Fork&maxAge=2592000)](https://https://github.com/suryapratapsinghsuryavanshi/solverjs//network/)
9+
[![GitHub stars](https://img.shields.io/github/stars/suryapratapsinghsuryavanshi/solverjs.svg?style=social&label=Star&maxAge=2592000)](https://https://github.com/suryapratapsinghsuryavanshi/solverjs//stargazers/)
10+
<br />
11+
12+
[![Welcome to my profile](https://img.shields.io/badge/Hello,Programmer!-Welcome-blue.svg?style=flat&logo=github)](https://github.com/suryapratapsinghsuryavanshi)
13+
[![Visits](https://komarev.com/ghpvc/?username=suryapratapsinghsuryavanshi&label=You%20Are%20Visitor%20No.&color=f20707&logo=github&style=flat-square)](https://github.com/suryapratapsinghsuryavanshi/solverjs)
14+
[![Open Source Love](https://badges.frapsoft.com/os/v2/open-source.svg?v=103)](https://github.com/suryapratapsinghsuryavanshi/solverjs)
15+
![Lines of code](https://img.shields.io/tokei/lines/github/suryapratapsinghsuryavanshi/solverjs?color=red&label=Lines%20of%20Code)
16+
![License](https://img.shields.io/badge/License-MIT-blue.svg)
17+
<br/>
18+
19+
[![Updated Badge](https://img.shields.io/github/last-commit/suryapratapsinghsuryavanshi/solverjs?label=Last%20Updated&style=flat)](https://github.com/suryapratapsinghsuryavanshi/solverjs/commits)
20+
[![Number of Contributors](https://img.shields.io/github/contributors/suryapratapsinghsuryavanshi/solverjs?style=flat&label=Contributors)](https://github.com/suryapratapsinghsuryavanshi/solverjs/graphs/contributors)
21+
[![Issues opened](https://img.shields.io/github/issues/suryapratapsinghsuryavanshi/solverjs?label=Issues)](https://github.com/suryapratapsinghsuryavanshi/solverjs)
22+
[![Issues closed](https://img.shields.io/github/issues-closed/suryapratapsinghsuryavanshi/solverjs?label=Issues)](https://github.com/suryapratapsinghsuryavanshi/solverjs/issues)
23+
[![PRs open](https://img.shields.io/github/issues-pr/suryapratapsinghsuryavanshi/solverjs?label=Pull%20Requests)](https://github.com/suryapratapsinghsuryavanshi/solverjs/pulls)
24+
[![PRs closed](https://img.shields.io/github/issues-pr-closed/suryapratapsinghsuryavanshi/solverjs?label=Pull%20Requests)](https://github.com/suryapratapsinghsuryavanshi/solverjs/pulls)
25+
<br/>
26+
27+
[![NPM Version][npm-image]][npm-url]
28+
[![NPM Downloads][downloads-image]][downloads-url]
29+
[![Linux Build][travis-image]][travis-url]
30+
[![Windows Build][appveyor-image]][appveyor-url]
31+
[![Test Coverage][coveralls-image]][coveralls-url]
1032

1133
[npm-image]: https://img.shields.io/badge/npm-v3.26.13-blue
1234
[npm-url]: https://www.npmjs.com/package/solverjs
13-
[downloads-image]: https://img.shields.io/badge/downloads-200%2FWeeks-green
35+
[downloads-image]: https://img.shields.io/badge/Downloads-200%2FWeeks-green
1436
[downloads-url]: https://www.npmjs.com/package/solverjs
15-
[travis-image]: https://img.shields.io/travis/expressjs/express/master.svg?label=linux
37+
[travis-image]: https://img.shields.io/travis/expressjs/express/master.svg?label=Linux
1638
[travis-url]: https://www.npmjs.com/package/solverjs
17-
[appveyor-image]: https://img.shields.io/appveyor/ci/dougwilson/express/master.svg?label=windows
39+
[appveyor-image]: https://img.shields.io/appveyor/ci/dougwilson/express/master.svg?label=Windows
1840
[appveyor-url]: https://www.npmjs.com/package/solverjs
19-
[coveralls-image]: https://img.shields.io/badge/coverage-2%25-yellow
41+
[coveralls-image]: https://img.shields.io/badge/Coverage-2%25-yellow
2042
[coveralls-url]: https://www.npmjs.com/package/solverjs
43+
</div>
44+
45+
<br/>
2146

22-
#
47+
# SolverJS
2348

2449
With web application all the time we face many problems to implement some logic, but in logic, we want some common mathematical applications like GCD, sum of all digits and this makes our implementation more complex hence If you want all these common math problems solved, then you can use solverjs.
2550
SolverJS are a combination of many common mathematical and some very used logic solutions.

0 commit comments

Comments
 (0)