Skip to content

Commit a44c5ff

Browse files
DevRabbDevRabb
committed
chore: add LICENSE, CONTRIBUTING, CODE_OF_CONDUCT, issue templates, PR template, CI workflow
1 parent 95488a1 commit a44c5ff

7 files changed

Lines changed: 283 additions & 0 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
name: Bug Report
3+
about: Something's broken aboard the mothership
4+
title: '[BUG] '
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
## 🐛 Describe the Bug
10+
11+
A clear and concise description of what the bug is.
12+
13+
## 🔁 Steps to Reproduce
14+
15+
1. Go to '...'
16+
2. Click on '...'
17+
3. See error
18+
19+
## ✅ Expected Behavior
20+
21+
What you expected to happen.
22+
23+
## ❌ Actual Behavior
24+
25+
What actually happened.
26+
27+
## 📸 Screenshots
28+
29+
If applicable, add screenshots to help explain the problem.
30+
31+
## 🖥️ Environment
32+
33+
- OS: [e.g. Windows 11, macOS 14]
34+
- Node version: [e.g. 20.11]
35+
- Browser: [e.g. Chrome 121]
36+
37+
## 📝 Additional Context
38+
39+
Any other context about the problem (error logs, console output, etc.)

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
name: Feature Request
3+
about: Propose a new abduction technique
4+
title: '[FEAT] '
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
## 🚀 Feature Description
10+
11+
A clear and concise description of the feature you'd like.
12+
13+
## 🤔 Problem It Solves
14+
15+
What problem does this feature solve? Who benefits from it?
16+
17+
## 💡 Proposed Solution
18+
19+
Describe how you'd expect this to work from a user's perspective.
20+
21+
## 🔄 Alternatives Considered
22+
23+
Any alternative approaches you've thought about?
24+
25+
## 📝 Additional Context
26+
27+
Screenshots, mockups, links to similar implementations, etc.

‎.github/pull_request_template.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
## 🛸 What does this PR do?
2+
3+
<!-- Brief description of the changes -->
4+
5+
## 🔗 Related Issue
6+
7+
Closes #<!-- issue number -->
8+
9+
## 🧪 Type of Change
10+
11+
- [ ] Bug fix
12+
- [ ] New feature
13+
- [ ] Refactor / code cleanup
14+
- [ ] Documentation update
15+
- [ ] Other (describe below)
16+
17+
## ✅ Checklist
18+
19+
- [ ] `npx tsc --noEmit` passes with no errors
20+
- [ ] Tested locally with a real Supabase project
21+
- [ ] No secrets or `.env.local` values committed
22+
- [ ] PR description clearly explains what changed and why
23+
24+
## 📸 Screenshots (if UI changes)
25+
26+
<!-- Before / after screenshots if applicable -->
27+
28+
## 📝 Notes for Reviewers
29+
30+
<!-- Anything the reviewer should know -->

‎.github/workflows/ci.yml‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [master, main]
6+
pull_request:
7+
branches: [master, main]
8+
9+
jobs:
10+
typecheck:
11+
name: TypeScript Check
12+
runs-on: ubuntu-latest
13+
14+
steps:
15+
- name: Checkout
16+
uses: actions/checkout@v4
17+
18+
- name: Setup Node.js
19+
uses: actions/setup-node@v4
20+
with:
21+
node-version: '20'
22+
cache: 'npm'
23+
cache-dependency-path: abductr/package-lock.json
24+
25+
- name: Install dependencies
26+
working-directory: abductr
27+
run: npm ci
28+
29+
- name: TypeScript typecheck
30+
working-directory: abductr
31+
run: npx tsc --noEmit
32+
33+
- name: ESLint
34+
working-directory: abductr
35+
run: npm run lint

‎CODE_OF_CONDUCT.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in the ABDUCTR community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
6+
7+
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
8+
9+
## Our Standards
10+
11+
Examples of behavior that contributes to a positive environment:
12+
13+
* Demonstrating empathy and kindness toward other people
14+
* Being respectful of differing opinions, viewpoints, and experiences
15+
* Giving and gracefully accepting constructive feedback
16+
* Accepting responsibility and apologizing to those affected by our mistakes
17+
* Focusing on what is best not just for us as individuals, but for the overall community
18+
19+
Examples of unacceptable behavior:
20+
21+
* The use of sexualized language or imagery, and sexual attention or advances of any kind
22+
* Trolling, insulting or derogatory comments, and personal or political attacks
23+
* Public or private harassment
24+
* Publishing others' private information without their explicit permission
25+
* Other conduct which could reasonably be considered inappropriate in a professional setting
26+
27+
## Enforcement Responsibilities
28+
29+
Project maintainers are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
30+
31+
## Scope
32+
33+
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces.
34+
35+
## Enforcement
36+
37+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening a GitHub Issue or contacting the maintainers directly. All complaints will be reviewed and investigated promptly and fairly.
38+
39+
## Attribution
40+
41+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.1.

‎CONTRIBUTING.md‎

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
# Contributing to ABDUCTR 🛸
2+
3+
Thanks for your interest in helping abduct more leads! Here's how to get involved.
4+
5+
---
6+
7+
## 🚀 Getting Started
8+
9+
1. **Fork** the repo on GitHub
10+
2. **Clone** your fork:
11+
```bash
12+
git clone https://github.com/YOUR_USERNAME/ABDUCTR.git
13+
cd ABDUCTR/abductr
14+
```
15+
3. **Install dependencies:**
16+
```bash
17+
npm install
18+
```
19+
4. **Copy the env template and fill in your own Supabase keys:**
20+
```bash
21+
cp .env.example .env.local
22+
```
23+
5. **Run the DB schema** in your Supabase SQL Editor:
24+
```
25+
supabase/schema.sql
26+
```
27+
6. **Start the dev server:**
28+
```bash
29+
npm run dev
30+
```
31+
32+
---
33+
34+
## 🌿 Branch Naming
35+
36+
Use a clear, descriptive branch name:
37+
38+
| Type | Format | Example |
39+
|---|---|---|
40+
| Bug fix | `fix/short-description` | `fix/proxy-crash-on-refresh` |
41+
| New feature | `feat/short-description` | `feat/linkedin-enrichment` |
42+
| Docs | `docs/short-description` | `docs/update-env-guide` |
43+
| Refactor | `refactor/short-description` | `refactor/cron-singleton` |
44+
45+
---
46+
47+
## 📋 Submitting a Pull Request
48+
49+
1. Make sure your branch is up to date with `main`:
50+
```bash
51+
git fetch origin
52+
git rebase origin/master
53+
```
54+
2. Run the TypeScript check before pushing:
55+
```bash
56+
npx tsc --noEmit
57+
```
58+
3. Push your branch and open a PR on GitHub
59+
4. Fill out the PR template — describe what changed and why
60+
5. Link any related issues (e.g. `Closes #12`)
61+
62+
---
63+
64+
## 🐛 Reporting Bugs
65+
66+
Open an [Issue](https://github.com/itsRabb/ABDUCTR/issues) using the **Bug Report** template.
67+
Include steps to reproduce, expected vs actual behavior, and your OS/Node version.
68+
69+
---
70+
71+
## 💡 Requesting Features
72+
73+
Open an [Issue](https://github.com/itsRabb/ABDUCTR/issues) using the **Feature Request** template.
74+
Explain the use case — why would this help ABDUCTR users?
75+
76+
---
77+
78+
## 🧠 Code Style
79+
80+
- TypeScript — no `any` unless absolutely necessary
81+
- Tailwind for all styling — no inline styles
82+
- Keep API routes thin; move logic to `lib/`
83+
- Comment anything non-obvious
84+
85+
---
86+
87+
## 📜 Code of Conduct
88+
89+
This project follows the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md).
90+
Be respectful. We're all just trying to abduct some leads. 👽

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2026 itsRabb
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

0 commit comments

Comments
 (0)