Hacktoberfest Kolkata 2022.pdf

2022 HACKTOBERFEST. ALL RIGHTS RESERVED
GitHub Campus Expert, Organizer
Hack4Bengal, LFX Mentee’21
Manish Kumar Barnwal
GitHub Campus Expert, Intern @
Harness.io, DigitalOcean Navigator
Hrittik Roy

What is opensource for you
in one word?

Have you heard about Git &
GitHub?

DigitalOcean / Agenda
Let’s understand Opensource
Flow of Git & GitHub
What is Hacktoberfest
Contributing and Understanding docs
WHAT
WILL WE COVER?
How & where to make your first contribution
What after Hacktoberfest!!
Quiz!!

Let’s Understand
Opensource!!
Hacktoberfest

DigitalOcean / The legacy
Learn Code Collaborate

DigitalOcean / Sponsorship
Values of
Opensource
Peer review
Opensource code is actively checked and
improved upon by peer programmers
Transparency
Open source allows you to check and
track your data yourself.
Reliability
Open source code outlives its original
authors because it is constantly updated

Values of
Opensource
Free of Cost
With open source the code itself is free
No vendor lock-in
Freedom for the user means that you can
take your open source code anywhere.
Open collaboration
Active open source communities means
that you can find help and resources.

Hacktoberfe
st
WHAT IS
HACKTOBERFEST?

Values
Hacktoberfest
DigitalOcean / Deals
EVERYONE IS WELCOME
Participants in Hacktoberfest come from all over the world
QUANTITY IS FUN, QUALITY IS KEY
All begins with meaningful contributions to open-source software
SHORT-TERM ACTION, LONG-TERM IMPACT
Your participation helps build the future of the internet.

Rules of
Hacktoberfest
Pull Requests
PR can be made in
any GitHub or
GitLab just look
for “hacktoberfest”
topic.
Prize
The first 40,000
participants can
elect to receive
prizes.
4 PRs Accepted
Have 4 PRs accepted
between October 1
and October 31 to
complete
Hacktoberfest

Avoid
SPAM
SPAMMY PRs
Maintainers: label spammy requests
“spam” and close them
LOW-QUALITY PR
Hacktoberfest is about contributing
meaningfully to open-source projects.
BAD REPOSITORIES
Repos that encourage simplistic PR/MRs
will be excluded from Hacktoberfest

Fork/Create Repository
Add & Commit Changes
Clone/Initialize
Pull/Push Changes
Flow of
Git & GitHub
Finally you may raise PR!!

How to land a PR?
Fork the repo you want to
contribute to
01.
Make changes. Stage, commit and push
them to your fork. Create a pull
request.
03.
Clone the fork on your
local machine
02.
Wait for a
maintainer to
review and merge
your PR
04.

Community website of OCY No Code Zone
Hack4Bengal’s website https:!/github.com/imanishbarnwa
l/Events-And-Hackathons
https:!/up-for-grabs.net/
Variety of Open Source
Projects by Open Codeyard
Find a place to
CONTRIBUTE
Add translations in
https:!/github.com/OpenCodeyard/
ocyclient
Open Source @ Appwrite

Read COC, Readme & contributing.md before
Contributing to a repo.
Ask open ended Questions!!
IMPORTANT

Hacktoberfe
st
WHAT AFTER
HACKTOBERFEST?

Let’s do
QnA

hack4bengal.tech

discord.io/hack4bengal

Quiz Time

github.com/imanishbarnwal/hacktoberfest-ccu

linktr.ee/manishbarnwal

DigitalOcean / Contact
@hrittikhere
@imanishbarnwal
Connect with us…

THANKS
FOR LISTENING

PRESENTED BY
Contributing and Understanding Docs

Hrittik Roy
Intern @ Harness.io
Technical Writer
DigitalOcean Navigator
GitHub Campus Expert
Google Venkat Scholar

Understanding Documentation
Important Files for you to Start
Why Documentation?
Contributing to Documentations
Agenda:
Some Tips

Why
Documentation?
Hacktoberfest

Contributors You Users
Help first time Contributors
onboard
For you who will be using your
Code in some months
Quick Start Guide, Show your
project exists
It Helps:

Min Components of
Documentati
on
Readme.md
Talks about the functionality of your project,
links to other docs
License
License so that others are free to use, change,
and distribute the software. Truly #oss
Contributing.md
Help new contributor to setup build
environment, dependencies and create PR

There’s More
Literal documentation or Installation
instructions
01.
API documentation
Use/Understand Function
Understand Arguments/Default Value of Function
03.
Examples and galleries
Small samples to test your
application
02.
Tutorials/Guides/FAQs
Whatever helps
users/you/contributor
04.

Hacktoberfest
Contributing to
Documentation

Value of
Starting
Read the Docs
Understanding aspects of Project
Build your Docs
Docs run on different templates/engines so run
them on your local setup!
Open collaboration
Collaborate on Issues/PRs and commit!

Types of
Contributions
Grammar
Fix the Grammar as
you go!
Logic
Fix issues you faced
while running the
docs!
Bonus: Diagrams
Translation
Help the project to
migrate to different
languages!

Hacktoberfest
Advice
Towards
Documentation

Values
Documentati
on
DigitalOcean
DOCUMENTATION IS LIKE CODE: IT NEEDS TO BE MAINTAINED
• Favor quality over quantity.
• All examples in the documentation should run automatically
IF IT IS NOT DOCUMENTED, IT DOES NOT EXIST
• Write documentation as you write code.
• Documentation driven development.
DOCUMENTATION IS ABOUT COMMUNICATION
• How to organize your ideas?
• Your Target Audience?

linktr.ee/hrittikhere

Hacktoberfest Kolkata 2022.pdf

Recommended

Recommended

More Related Content

Similar to Hacktoberfest Kolkata 2022.pdf

Similar to Hacktoberfest Kolkata 2022.pdf (20)

Recently uploaded

Recently uploaded (20)

Hacktoberfest Kolkata 2022.pdf