Skip to content

Revamp README for Hacktoberfest 2025 contributions #12 #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Aujasyarajput18 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Revamp README for Hacktoberfest 2025 contributions #12 #13

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
215 changes: 213 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,213 @@
# Hacktoberfest2025
Hacktoberfest2025
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Project README — Hacktoberfest 2025</title>
<style>
:root{--bg:#0f1724;--card:#0b1220;--muted:#9aa6b2;--accent:#60a5fa;--surface:#071027}
html,body{height:100%;margin:0;font-family:Inter,ui-sans-serif,system-ui,-apple-system,"Segoe UI",Roboto,"Helvetica Neue",Arial}
body{background:linear-gradient(180deg,#071028 0%, #071834 60%);color:#e6eef6;line-height:1.6}
.wrap{max-width:980px;margin:36px auto;padding:28px;background:linear-gradient(180deg,rgba(255,255,255,0.02),rgba(255,255,255,0.01));border-radius:12px;box-shadow:0 8px 30px rgba(2,6,23,0.6)}
header{display:flex;align-items:center;gap:16px}
.logo{width:56px;height:56px;border-radius:8px;background:linear-gradient(135deg,var(--accent),#7dd3fc);display:flex;align-items:center;justify-content:center;color:#022; font-weight:700}
h1{margin:.15rem 0;font-size:1.6rem}
p.lead{color:var(--muted);margin-top:6px}
nav{margin-top:20px;display:flex;gap:12px;flex-wrap:wrap}
nav a{color:#cfe9ff;text-decoration:none;padding:8px 12px;border-radius:8px;background:rgba(255,255,255,0.02)}
section{margin-top:26px;padding:20px;background:rgba(255,255,255,0.01);border-radius:10px}
h2{margin-top:0}
code, pre{background:#021224;border-radius:8px;padding:10px;color:#d6f0ff;display:block;overflow:auto}
.two-col{display:grid;grid-template-columns:1fr 320px;gap:18px}
aside{background:rgba(255,255,255,0.01);padding:16px;border-radius:10px}
ul.check{list-style:none;padding-left:0}
ul.check li{position:relative;padding-left:28px;margin:8px 0}
ul.check li:before{content:"✓";position:absolute;left:0;top:0;color:var(--accent)}
.cta{display:inline-block;margin-top:12px;padding:10px 14px;border-radius:8px;background:var(--accent);color:#012;font-weight:600;text-decoration:none}
footer{margin-top:20px;color:var(--muted);font-size:0.9rem}
.small{font-size:0.9rem;color:var(--muted)}
.kbd{background:#021a2b;padding:4px 8px;border-radius:6px;border:1px solid rgba(255,255,255,0.03)}
</style>
</head>
<body>
<div class="wrap">
<header>
<div class="logo">HF</div>
<div>
<h1>Repository README — Hacktoberfest 2025</h1>
<p class="lead">A friendly, contribution-first README guiding Hacktoberfest contributors: project goals, how to contribute, setup, examples, and links to a CONTRIBUTING.md.</p>
</div>
</header>

<nav>
<a href="#goal">Project Goal</a>
<a href="#what-to-contribute">What to Contribute</a>
<a href="#how-to-contribute">How to Contribute</a>
<a href="#setup">Setup</a>
<a href="#examples">Examples</a>
<a href="#contributing-md">CONTRIBUTING.md</a>
</nav>

<div class="two-col">
<main>
<section id="goal">
<h2>Project Goal</h2>
<p>This repository collects beginner-friendly resources, small algorithm problems, and short web projects ideal for Hacktoberfest 2025 contributors. The aim is to provide a welcoming place for first-time open-source contributors to learn Git, make meaningful PRs, and ship small, well-tested contributions.</p>
<ul class="check">
<li>Grow a curated set of beginner issues and small projects</li>
<li>Encourage clear PRs with tests or demos</li>
<li>Maintain a friendly environment with a Code of Conduct</li>
</ul>
</section>

<section id="what-to-contribute">
<h2>What kinds of contributions are welcome</h2>
<p>We welcome diverse contributions. The most useful ones for Hacktoberfest are marked <span class="kbd">good-first-issue</span> or <span class="kbd">help-wanted</span> in the issues list.</p>
<ul>
<li><strong>Algorithms & Data Structures</strong> — single-file solutions with explanation and time/space complexity.</li>
<li><strong>Small Web Projects</strong> — static HTML/CSS/JS mini-apps (<= 200KB) or single-file React components.</li>
<li><strong>Utilities & Scripts</strong> — Python/JS scripts that solve a small problem or show a useful workflow.</li>
<li><strong>Docs & Examples</strong> — improve documentation, add examples, or write tutorials for existing modules.</li>
<li><strong>Tests</strong> — add unit tests for existing functions (preferred test frameworks listed in CONTRIBUTING.md).</li>
</ul>
</section>

<section id="how-to-contribute">
<h2>How to Contribute (step-by-step)</h2>
<p>Follow these simple steps to get your PR accepted:</p>

<ol>
<li><strong>Fork</strong> the repo using the GitHub UI.</li>
<li><strong>Clone</strong> your fork locally:
<pre><code>git clone https://github.com/&lt;your-username&gt;/&lt;repo-name&gt;.git
cd &lt;repo-name&gt;</code></pre>
</li>
<li><strong>Create a branch</strong> for your change:
<pre><code>git checkout -b feat/my-cool-contribution</code></pre>
</li>
<li><strong>Make changes</strong> — keep them small and focused. Add tests or a demo where applicable.</li>
<li><strong>Commit</strong> with a clear message:
<pre><code>git add .
git commit -m "feat: add binary-search example with explanation"</code></pre>
</li>
<li><strong>Push</strong> the branch to your fork:
<pre><code>git push origin feat/my-cool-contribution</code></pre>
</li>
<li><strong>Open a Pull Request</strong> from your fork/branch to <code>main</code>. Use the PR template (if present) and describe your change, the motivation, and any testing you did.</li>
<li><strong>Respond to review comments</strong> — maintainers may request changes. Keep communication friendly and concise.</li>
</ol>

<p class="small">Tip: If you're not sure where to start, look for issues labeled <span class="kbd">good-first-issue</span> or leave a comment on the issue to ask for guidance.</p>
</section>

<section id="setup">
<h2>Setup Instructions (if applicable)</h2>
<p>The repository is intentionally lightweight. Typical setup steps for code contributions:</p>
<ul>
<li>Install Git (version &gt;= 2.20).</li>
<li>For JS projects: Node.js LTS (v18+) and yarn or npm.</li>
<li>For Python scripts: Python 3.10+ and a virtual environment.</li>
</ul>

<p>Example: setting up a Python dev environment</p>
<pre><code>python -m venv .venv
source .venv/bin/activate # macOS/Linux
.venv\Scripts\activate # Windows
pip install -r requirements.txt</code></pre>

<p>Example: setting up a small JS demo</p>
<pre><code>npm install
npm run dev
# or
npx serve ./demo</code></pre>
</section>

<section id="examples">
<h2>Examples & Contribution Format</h2>
<p>Prefer single-purpose contributions with a clear README or top comment explaining:</p>
<ul>
<li>What the file does</li>
<li>How to run it</li>
<li>Complexity analysis (for algorithms)</li>
</ul>

<h3>Example algorithm contribution (file: <code>algorithms/binary_search.py</code>)</h3>
<pre><code># binary_search.py
# Binary search implementation
# Time: O(log n), Space: O(1)

def binary_search(arr, target):
lo, hi = 0, len(arr)-1
while lo <= hi:
mid = (lo+hi)//2
if arr[mid] == target:
return mid
if arr[mid] < target:
lo = mid+1
else:
hi = mid-1
return -1

# Example usage
if __name__ == '__main__':
print(binary_search([1,2,3,4,5], 3))
</code></pre>

<h3>Example web contribution (folder: <code>/demos/todo-widget</code>)</h3>
<pre><code>index.html <!-- single file static demo with inline CSS/JS -->
README.md <!-- short instructions and demo screenshots -->
</code></pre>
</section>

<section id="contributing-md">
<h2>CONTRIBUTING.md & Additional Policies</h2>
<p>If a <code>CONTRIBUTING.md</code> file exists, please follow it — it contains repo-specific rules (test commands, code style, and preferred branching conventions). If it doesn't exist, create one when adding larger projects or repeat the minimal guidance below:</p>

<pre><code># CONTRIBUTING.md (minimal template)
1. Follow the How to Contribute steps in README.md
2. Keep PRs small and focused
3. Add tests or a short demo when possible
4. Use clear commit messages
5. Respect the Code of Conduct
</code></pre>

<p class="small">Consider adding templates for issues and pull requests (.github/ISSUE_TEMPLATE, PULL_REQUEST_TEMPLATE) to standardize contributions.</p>
</section>

</main>

<aside>
<h3>Quick Links</h3>
<ul>
<li><strong>Labels to use:</strong> <span class="kbd">good-first-issue</span>, <span class="kbd">help-wanted</span>, <span class="kbd">documentation</span></li>
<li><strong>Branch:</strong> Primary branch is <span class="kbd">main</span></li>
<li><strong>PR checks:</strong> Add tests or a demo screenshot where relevant</li>
</ul>

<h3>PR Template (short)</h3>
<pre><code>### Summary
What changed and why.

### How to test
Steps to reproduce or run.

### Checklist
- [ ] Tests added
- [ ] Docs updated
</code></pre>

<a class="cta" href="#how-to-contribute">Start Contributing</a>

<div style="margin-top:12px" class="small">
<strong>Code of Conduct</strong>
<p>Be respectful and helpful. A short code of conduct is recommended (Contributor Covenant or similar).</p>
</div>
</aside>
</div>

<footer>
Maintainers: Add your contact & preferred response time here. Best practice: reply to Hacktoberfest PRs within 72 hours.
</footer>
</div>
</body>
</html>