Skip to content

Latest commit

 

History

History
46 lines (29 loc) · 3.14 KB

CONTRIBUTING.md

File metadata and controls

46 lines (29 loc) · 3.14 KB

Contributing to Electroverse 👋

Hey! We are glad you're here, ready to contribute to this community driven repository?

💡 Let's Contribute

New implementation is welcome! Please check whether the circuit has already been implemented to a problem in the DIRECTORY.md, according to which you can submit a valid pull request.

As of 1st July, 2022, we have categorised the repository into 5 sections. Below you can see their respective name and role:

  • Basics 1 $\rightarrow$ The circuits deal with interfacing individual electrical components with Arduino.
  • Basics 2 $\rightarrow$ Interfacing 2 or more simple electrical components with Arduino
  • Intermediate 1 $\rightarrow$ Relatively simple systems compared to Intermediate 2
  • Intermediate 2 $\rightarrow$ Good looking Systems
  • PCB Designs $\rightarrow$ Implementation of PCB designs for the circuits present in all the above folders

Improving comments and writing proper documentation are also highly welcome.

🚦 Quickstart

⚡ We wanted this repository to be beginner friendly, so it would be very helpful if the contributors could contribute in the mentioned standard:

  • Use Images/GIF wherever possible, either to display the working or the output.
  • Lay out a really nice documentation for the readers.
  • Make sure to point to the important files for implementation.
  • Adding valid comments to the code wherever required would be super helpful.
  • If you have referred/learnt from some external link, mention them as well.
  • Have Fun!

📋 Reporting Issues

If you find any issues in the existing files in the repository, please check if your issue has already been filed by someone else by searching the existing issues before filing a new one.

  • Create a new issue

If you spot a problem, search if an issue already exists. If a related issue doesn't exist, you can open a new issue using a relevant issue form.

  • Solve an issue

Scan through our existing issues to find one that interests you. If you find an issue to work on, you are welcome to open a PR with a fix.

📍 Are you new to Pull requests? Head over to the PR documentation.


Join Now