![Commits Badge](https://badges.pufler.dev/commits/monthly/shubham2704)
Utility is meant to be a simple easy to use unit conversion website plus bunch of utility tools. This will be a static website made completly from HTML,CSS and Javascript or any other Frontend Framwork.
Visit the Website - http://codeezzi-utility.surge.sh/ or click here.
Our Contributors - contributors
If you want to add Color Gradients to your code click here or visit : https://backgroundgradients.com/
Tools marked with ☑ are already completed
Note: Please Don't Make Any Changes In index.html
AND contributors.html
Note: Please read CONTRIBUTING.md before making any pull requests
Types of Tools to be Added
- [x] Temperture
- [x] Length
- [x] [weight]conversionTools/weight/weight.html)
- [x] speed
- [ ] [currency]
- [ ] [time]
- [ ] [area]
- [x] fuel
- [x] pressure
- [x] energy
- [ ] [current]
- [ ] [force]
- [ ] [sound]
- [x] frequency
- [x] image
- [ ] [radiation]
- [x] resistence
- [ ] [power]
- [ ] [flow]
- [x] angle
- [ ] [magnet]
- [ ] [viscosity]
- [x] torque
- [x] density
- [ ] [conductance]
- [ ] [inductance]
- [ ] [capacitence]
- [ ] [heat density]
- [ ] [surface tension]
- [ ] [resolution]
- [ ] [charge]
- [x] storage
Feel free to suggest if important tools are missing.
- Ensure that no one is working on (or already completed) the tool you want to work on.
- Use descriptive commit messages
- You can create an issue for the tool you want to claim and work on
- You can only use javascript.
- After completing the tool add it to the
assets/config/tools.js
under the related category
- FOLLOW THE DIRECTORY STRUCTURE AND NAMING CONVENTION
- UPDATE THE
README.md
FILE AS YOU WORK ON A NEW TOOL
Contributing Guidelines
Follow the theme design/ Follow the design of index.html
file.
Folders and Files
- Please make sure your folder is in any one of the Folder
conversionTools
,mathmeticlaTools
,financeTools
or dailyUseTools
. For example if you want to work on length conversion tool then place your folder in the conversionTools
folder. The list for tools with their respective folder is mentioned above
- The name of your folder should be the name o the tool you are working on for example: if you want to work on length conversion tool, Then name your folder would be
length
.
- Under your folder name your files as follows. For length conversion tool the files would be
length.html
, length.css
,length.js
- Copy the content of
boilerplate.template
to your tool's html file and follow the comments marked with $.
- At the end add your tool to the
assers/config/tools.js
under the related category
- Add your name to the footer of your tool's html you are working on. For example if you are working on length conversion tool then
add your name in the footer of
lenght.html
.
Tools.js
- Find your tool's category
- Inside the tool's category array, add the tool object
- Add title in a well formatted text; for example:
Length Conversion
.
- Add a short description about your tool.
- Add URL of your tool following this format:
/FOLDER_NAME/TOOL_HTML_NAME.html
Opening Issues
When you open an issue, please make sure the Tool is not already implemented.
Opened Issues by existing Problem will be closed & PR made to this Issue marked as spam
The Contributor who opened an issue will be assigned/prefered to the issue. If there is no PR within about 7 Days the issue will be assigned to another Contributor.
Pull Requests
- Only Pull Requests joined with an Issue and matching the naming-conventions (See Folders and Files) will be merged!
- If there is no Issue joined in the PR your PR will be labled as spam and closed.
- If your code don't passes the Checks your PR will be labled as "invalid" and the Issue stays open for the next PR!
- If your PR doesn't follow the Contributing Guidelines of this Repository it will be also marked as spam and closed!
Getting Started
- Fork this repository (Click the Fork button, top right of this page)
- Clone your fork down to your local machine
git clone https://github.com/your-username/utility.git
- Comment to the Issue you want to work on - so I can assign you to it OR create a new Issue.
- Create a branch for a new feature
git checkout -b feature/branch-name
- Or if its a bugfix to a file
git checkout -b bugfix/branch-name
- Make your changes (choose from the Tasks above!)
- Commit and Push
git add .
git commit -m 'commit message'
git push origin branch-name
- Create a New Pull Request from your forked repository ( Click the 'New Pull Request' Button located at the top of your repo)
- Wait for your PR review and merge approval!
- Star this repository if you had fun!
Which PR will be accepted?
- Ones you are assigned to.
- Your PR has to link the Issue.
- Your Solution must be correct.
Thank You!