Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
10 changes: 10 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# top-most EditorConfig file
root = true

[*]
charset = utf-8
end_of_line = lf
insert_final_newline = true
indent_style = tab
indent_size = 4
tab_width = 4
3 changes: 3 additions & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
node_modules/

main.js
23 changes: 23 additions & 0 deletions .eslintrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{
"root": true,
"parser": "@typescript-eslint/parser",
"env": { "node": true },
"plugins": [
"@typescript-eslint"
],
"extends": [
"eslint:recommended",
"plugin:@typescript-eslint/eslint-recommended",
"plugin:@typescript-eslint/recommended"
],
"parserOptions": {
"sourceType": "module"
},
"rules": {
"no-unused-vars": "off",
"@typescript-eslint/no-unused-vars": ["error", { "args": "none" }],
"@typescript-eslint/ban-ts-comment": "off",
"no-prototype-builtins": "off",
"@typescript-eslint/no-empty-function": "off"
}
}
9 changes: 9 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# 🀝 Code of Conduct

All contributors are expected to foster a safe, respectful, and inclusive environment.

## πŸ’« The PtiCalin Pledge

We commit to kindness, curiosity, and compassion β€” toward ourselves and each other.

Violations may result in moderation actions. See the full [Contributor Covenant](https://www.contributor-covenant.org/) for details.
87 changes: 87 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
# ✨ Contributing Guide

Thank you for considering a contribution to this project!
This repo is built on curiosity, creativity, and care β€” and *you* are part of that magic.

---

## 🧩 Ways to Contribute

πŸͺ„ Whether you're a coder, documenter, designer, or dreamer β€” here are some great ways to help:

- πŸ“š Improve documentation or fix typos
- πŸ› Report bugs using the [Bug Report Template](https://github.com/your-username/vaultos-plugin-template/issues/new?template=bug.yml)
- 🌟 Suggest new features or enhancements
- πŸ§ͺ Write or improve tests
- πŸ”§ Refactor or optimize code
- πŸ—£οΈ Start a conversation in [GitHub Discussions](https://github.com/PtiCalin/general-template-repo/discussions)

---

## πŸ›  Getting Started

### 1. Fork + Clone

```bash
git clone https://github.com/PtiCalin/general-template-repo.git
cd general-template-repo
```

### 2. Create a Branch

```bash
git checkout -b feat/amazing-idea
```

### 3. Make Your Changes

Edit files, add new content, or work your magic β€” then:

```bash
git add .
git commit -m "Add: your amazing contribution"
git push origin feat/amazing-idea
```

---

## πŸ“¦ Open a Pull Request

Once your changes are pushed:

1. Go to GitHub and open a Pull Request
2. Use the [Pull Request Template](.github/pull_request_template.md)
3. Reference related issues (e.g. `Closes #3`)
4. Write clearly and kindly β€” we want to celebrate your work!

---

## πŸ€– Code Style & Conventions

- Follow formatting rules (`prettier`, `black`, etc.)
- Stick to existing folder and naming conventions
- Keep code modular, clean, and minimal where possible

---

## πŸ’– What We Value

We especially appreciate:

- Kind and constructive communication
- Attention to clarity (docs are love!)
- Inclusivity and accessibility
- Learning in public and sharing growth

---

## 🌿 Final Notes

Not sure where to start? Open a [Discussion](https://github.com/PtiCalin/general-template-repo/discussions) or draft a PR early to get feedback.

You're not just contributing to code β€” you're growing a thoughtful and joyful digital garden 🌼

---

With gratitude,
β€” The PtiCalin Project Team πŸ§ πŸ’«
4 changes: 4 additions & 0 deletions .github/FUNDING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Funding

github: ['PtiCalin']
buy_me_a_coffee: pticalin
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: πŸͺ² Bug Report
description: Report a bug or glitch with this project.
title: 'Bug: {Issue Summary}'
labels:
- bug
- investigation needed
body:
- type: textarea
id: what-happened
attributes:
label: What happened?
description: Clearly describe the issue.
validations:
required: true
- type: textarea
id: where
attributes:
label: Where?
description: File, module, or workflow where the bug occurred.
validations:
required: true
- type: textarea
id: steps
attributes:
label: Steps to Reproduce
description: Step-by-step instructions to reproduce the issue.
- type: textarea
id: suggestion
attributes:
label: Any thoughts on fixing it?
description: Optional ideas or clues.
21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
name: Bug report
about: Create a report to help us improve this project
labels: bug
---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Environment**
- OS: [e.g. Windows 11]
- Application version: [e.g. 1.0.0]
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/cleanup.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
name: 🧹 Repository Cleanup
description: 'Schedule a cleaning session: archiving, deleting, merging.'
title: 'Cleanup: {Scope}'
labels:
- cleanup
- maintenance
body:
- type: textarea
id: scope
attributes:
label: What needs cleaning?
description: Describe the folder, section, or item that needs maintenance.
validations:
required: true
- type: textarea
id: method
attributes:
label: How to proceed?
description: Plan for archiving, deleting, merging, or reorganizing.
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/content.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: ✍️ New Content Entry
description: Log a new module or snippet added to the project.
title: 'New: {Page or Template Name}'
labels:
- new content
- project growth
body:
- type: textarea
id: description
attributes:
label: What did you create?
description: Describe the new content.
validations:
required: true
- type: input
id: location
attributes:
label: Where is it located?
description: Folder/path inside the project.
validations:
required: true
- type: textarea
id: notes
attributes:
label: Future plans or linking ideas
description: Any notes or next steps?
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
name: 🧭 Documentation Task
description: Improve the README, wiki, or project documentation.
title: 'Docs: {Area}'
labels:
- documentation
- task
body:
- type: textarea
id: what-docs
attributes:
label: What part of the documentation?
description: Specify which file, page, or guide.
validations:
required: true
- type: textarea
id: improvement
attributes:
label: How should it improve?
description: Suggest what to add, fix, or clarify.
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: 🌟 Feature Request
description: Suggest a new feature or improvement for this project.
title: 'Feature: {Idea}'
labels:
- feature request
- enhancement
body:
- type: textarea
id: feature
attributes:
label: What is the feature?
description: Describe the new idea.
validations:
required: true
- type: textarea
id: benefit
attributes:
label: Why would it be useful?
description: Explain why this would improve the project.
- type: textarea
id: notes
attributes:
label: Optional sketches or examples
description: Any mockups, files, or examples.
14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
name: Feature request
about: Suggest an idea or improvement for this project
labels: enhancement
---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is.

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Additional context**
Add any other context or screenshots about the feature request here.
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/general.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
name: πŸ’‘ Idea / Brainstorm
description: Capture a new idea.
title: 'Idea: {Short Summary}'
labels:
- idea
- brainstorm
body:
- type: textarea
id: idea
attributes:
label: What's the idea?
description: Let it flow!
validations:
required: true
- type: textarea
id: notes
attributes:
label: Wild thoughts or variations
description: Alternative angles or crazy versions.
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/goal-planning.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: 🎯 Goal Planning
description: Plan a focused project goal.
title: 'Goal: {Objective}'
labels:
- goal
- planning
body:
- type: textarea
id: goal
attributes:
label: What's the goal?
description: Describe the objective.
validations:
required: true
- type: textarea
id: steps
attributes:
label: Steps to achieve it
description: List the key steps.
- type: textarea
id: timeline
attributes:
label: Ideal timeline
description: Is there a deadline or priority?
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/refractor.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: πŸ› οΈ Refactor / Improve Structure
description: Propose a reorganization, renaming, or structural update.
title: 'Refactor: {Area or Item}'
labels:
- refactor
- structure improvement
body:
- type: textarea
id: current-structure
attributes:
label: Current Structure
description: What does the structure look like right now?
validations:
required: true
- type: textarea
id: proposed-change
attributes:
label: Proposed Change
description: Describe the improvements you propose.
validations:
required: true
- type: textarea
id: reasons
attributes:
label: Why change this?
description: Why would this make the project better?
Loading
Loading