DEV Community

Cover image for Create your own calculator
Ruan Aragão
Ruan Aragão

Posted on

Create your own calculator

Intro

For some years now, participating as a supporter during Hacktoberfest editions, small projects are always offered to the beginner public, so that they can make a valid contribution and learn more about how to contribute in the correct way.

RuanAragao (Ruan Aragão) · GitHub

curl -L https://ruanaragao.com.br/what. RuanAragao has 225 repositories available. Follow their code on GitHub.

favicon github.com

Project

The project I focused on in this edition was a calculator, yes, but I'll explain it better below.

The proposal is for users to create their own calculators. The project has an index.html which has a title and links to each calculator. There is also a directory called calculators.

GitHub logo RuanAragao / calculator

Create your own calculator

Calculator

Create your own calculator

How

⚠️ Firstly, be willing to learn and/or teach. This project is not a PR farm for hacktoberfest.

  1. Star ✨ this project 👀🫶

  2. Go to issues and create a new. Add the name of your calculator in title and comment a short purpose of your calculator.

Example:


title:

Screw calculator

comment:

convert weight to units

  1. Fork this project

  2. Create a folder in [root]/calculators with the name of your calculator using the Kebab case convention.

Example:


mkdir example-calculator > [root]/calculators/example-calculator

  1. Inside your folder calculator is required index.html file with your calculator.
  2. Edit the /index.html file and add the your calculator folder link in alphabetical order with a <br> in the end

    Example:


    <a href="/calculators/example-calculator">Example Calculator</a><br/>

  3. Open your pull request with "Closes #{your-issue-number}". Example "Closes #10".

Contributing

Steps to contribute:

  • Fork the repository by clicking the "Fork" button in the upper right corner of this page.
  • Clone…

The contributor creates an issue explaining the function of his calculator (his proposal), he must create his calculator following some basic rules: it will be created within the /calculators directory and within its own directory; there should be at least one file called index.html; add the relative link of the calculator to the list of links in the main index.html.

calculator
├── calculators
│   └── my-awesome-calculator
│       ├── index.html
│       ├── style.css (optional)
│       └── script.js (optional)
└── index.html
Enter fullscreen mode Exit fullscreen mode

File and directory names should follow the Kebab Case convention.

Highs and Lows

The challenge of managing people, especially when there are prizes involved. This edition I noticed something new, the generation of code through AI, not just snippets of code, but the entire code, and often the participants had no idea how the code that was generated worked.

I expected this, but it is still something that causes a certain sadness in us, especially when the person is not worried about learning, about receiving feedback, but just wants to push any PR up to the repository and repeatedly asks us to accept the PR.

But overall it was really cool, many were there genuinely contributing.

Growth

Without a doubt, it was really cool to participate again this time and get the community moving a little, especially allowing some people to contribute for the first time in their lives. I am finishing this edition with more experience in managing projects involving people of multiple nationalities and levels of knowledge.

Top comments (1)

Collapse
 
pypimo profile image
pypimo

cool project !!