Iran Open Source Hackathon

Last update: Dec 25, 2022

Related tags

Overview

Iran Open Source Hackathon is an open-source hackathon (duh) with the aim of encouraging participation in open-source contribution amongst Iranian developers. There is a curated list of repositories whose maintainers volunteered to be part of the hackathon. Contribute to any of these repositories during the hackathon, and at the end top contributors will be acknowledged here (so yes in the end its just about bragging rights).

👉 If you are a maintainer and want to enter some of your repositories in the hackathon so our participants will contribute to them, check this section.

A Note on Terminology

In these documents, keywords MUST, MUST NOT, REQUIRED, SHALL, SHALL NOT, SHOULD, SHOULD NOT, RECOMMENDED, MAY, and OPTIONAL, when appearing in caps lock and in bold, are to be interpreted as described in RFC 2119. This is not a software spec document, but still the extra clarity helps avoiding confusion.

⚠️

⚠️ WORK IN PROGRESS NOTICE

This is work in progress. As long as this notice is up here, any rule, date, information, etc is subject to sudden change without any prior notice.

If a piece of information is followed by ⚠️, then there is a good chance we will change it in near future and current information is mostly a placeholder.

How Can I Participate?

Contribute to one of these repositories during the time of the hackathon:

Make a pull request, include #iosh ⚠️ in its title ⚠️ .
The pull request MUST be accepted to the repository before the end of the hackathon.
Each pull request will count towards your total score (depends on how many lines of code it is ⚠️ ).
At the end, top 5 ⚠️ contributors (highest scores ⚠️ ) will be acknowledged here. We might update the list during the hackathon as well.

👉 If you are unfamiliar with open-source contribution, git or github, take a look at these resources.

NOTE: Please carefully read our code of conduct before you start contributing.

Why Should I Participate?

You will help improve software that people like you use (apes together strong).
You will learn a lot (like seriously, a TON).
You will earn street-cred (which also helps with employability).

I Am A Maintainer. Can I Add My Repos To This Hackathon?

Of course! You need to:

Fork this repository.
For each repository like https://github.com/jafar/my-repo, add a yaml file to first/repos
(i.e. first/repos/jafar/my-repo.yaml):

# first/repos/jafar/my-repo.yaml

name: My Cool Repository
description: I am particularly cool here
languages:
  - JavaScript
  - Hashemi
  - ...

Make a pull request.

👉 You can see examples in the repos directory.

👉 You can add a list of maintainers (with whom hackathon participants can be in contact) as well:

# first/repos/jafar/my-repo.yaml

name: My Cool Repository
description: I am particularly cool here
languages:
  - JavaScript
  - Hashemi
#
# 👉 for user `https://github.com/asghar`, add `asghar` to this list
# 👉 also don't forget the repo owner if they are going to be a maintainer as well
#
maintainers:
  - jafar
  - asghar
  - nooshin
  - maliheh

👉 If your repo belongs to a company or organization, you MUST specify maintainers independently.

NOTE: Please carefully read our code of conduct before you submit your repositories.

Repositories

Name	Description	Owner	Maintainer(s)	Languages
FL Chart	A powerful Flutter chart library, currently supporting Line Chart, Bar Chart, Pie Chart, Scatter Chart and Radar Chart.	imaNNeoFighT	imaNNeoFighT	dart
Letiner	An intelligent Leitner to memorize information, especially words, without needing to maintain boxes manually. It can be synced with Dropbox.	justmisam	justmisam	Javascript, HTML, CSS
Lightweight Message Queue (LMQ)	A lightweight message queue to work with short messages or content references as messages.	justmisam	justmisam	Go
PyLMQ	Python Library for LMQ	justmisam	justmisam	Python
BarnameKon	Telegram bot which create "Add to Google Calendar" link for your events.	anvaari	anvaari	python
TyFON	Typed Functions Over Network	loreanvictor	loreanvictor	typescript, javascript
Callbag JSX	callbags + JSX: fast and tiny interactive web apps	loreanvictor	loreanvictor	typescript
Peanar	A background job scheduler for Node.js based on RabbitMQ	martianboy	martianboy	typescript
divar-starter-kit	React.js SSR-ready boilerplate using Razzle.	divar-ir	iMohammadReza	javascript
gRPC Go Contracts	Verify the communication of your microservices by writing contracts for your RPCs	shayanh	shayanh	go
thatcher-effect-dataset-generator	Using OpenCV to apply Thatcher effect on a set of face images	erfaniaa	erfaniaa	Python
text-to-commit-history	Write a large text on your Github profile, with your commits history (contribution graph).	erfaniaa	erfaniaa	Python
Keepalived Exporter	Prometheus exporter for Keepalived metrics.	cafebazaar	mehdy	go
Anbar	A basic S3 compatible storage server in Rust.	mehdy	mehdy	rust
Pyeez	A simple framework to create console applications (like htop).	mehdy	mehdy	python
paperify	Backup files on paper using QRCodes.	alisinabh	alisinabh	shell
Zarb project	Zarb blockchain	zarbchain	b00f	Go, Rust, Javascript
Laravel Toman	Elegant Zarinpal and IDPay payment gateways for Laravel	evryn	AmirrezaNasiri	PHP

To be completed

Duration

Beginning	تیر ۱۵	06 July
Ending	شهریور ۱۵	06 September

۱۴۰۰ / 2021

👉 For Participants

Your pull requests MUST be submitted after beginning of the hackathon period and be merged before the end of the hackathon.

👉 For Maintainers

Ideally, submit your repositories before the start of the hackathon, though you can ( ⚠️ ) submit it during the duration of the hackathon as well.

Top Contributors

To be determined

Comments

Improvements on process of submitting repos
Add a guideline on how to submit new repos

Add a guideline for running the table generation script locally (dependencies, arguments, etc)

Improvements to structure of the YAML files:

Repo owner MUST match the name of the folder, so there is no need for including it in the YAML file.

Repository MUST match the name of the file, so the link to it can be deduced automatically as well.

Languages can be read from GitHub itself (example). I am not sure what would be the best way of incorporating this though since also caching this info and not spamming GitHub API would be nice.

documentation enhancement
opened by loreanvictor 5
Validate maintaners url #52

Update validate script so that it also checks URLs for maintainers and fails the CI check. And some changes in code for avoiding code repetition and resolves #52

opened by amireshoon 3
Update Readme to reflect final rules

This section requires updating based on our current scoring scripts. We should also take out all WORK-IN-PROGRESS notices from the README now since everything is finalized.
bug documentation

opened by loreanvictor 3
A Bot to Answer Some Questions About Some Stats
Maybe add a Gitter (or GitHub Discussions) Bot to respond to some questions automatically:

How many repos are there?

Who are top maintainers?

Which are top repos?

What is this about?

etc.
good first issue fluff
opened by loreanvictor 0
Check Maintainers Name in Repo File
Currently, the validate and the update repo table scripts only check the URL of the repository and not the names of the maintainers. This has already caused an issue once where maintainers have entered their name instead of their GitHub user names, which results in wrong links in the repo table (and in case there is a space inside their name, weird formatting).

Since this results in confusion and wrong data entry, I will mark it as a bug.

[x] Update readme, so that it is more clear that GitHub username must be entered

[ ] Update validate script, so that it also checks URLs for maintainers and fails the CI check

bug
opened by loreanvictor 0
Promote the Hackathon
After rules for PR and stuff are fixed, find channels to promote the event inside (max in 2 weeks from now).

[ ] University Groups

[ ] Twitter

[ ] Instagram

[ ] ClubHouse?

[ ] Various Companies

[ ] YouTube

Also please add any items to this list if something is missing.
outreach
opened by loreanvictor 0