Skip to content

Commit 6f397de

Browse files
Oxternal-0xOxternal-0x
committed
Added Rules
Adding rules, regs and donations
1 parent 3358b3c commit 6f397de

File tree

9 files changed

+532
-0
lines changed

9 files changed

+532
-0
lines changed

‎.github/FUNDING.yml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# These are supported funding model platforms
2+
3+
# Replace the Gist URL with your actual one once created
4+
custom: ['https://gist.github.com/Oxternal-0x/REPLACE_WITH_YOUR_ACTUAL_GIST_ID']

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
name: Bug Report
3+
about: Create a report to help us improve
4+
title: "[BUG] "
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots**
24+
If applicable, add screenshots to help explain your problem.
25+
26+
**Environment (please complete the following information):**
27+
- OS: [e.g. Windows 10, macOS Sonoma]
28+
- VS Code Version: [e.g. 1.85.1]
29+
- Extension Version: [e.g. 1.0.0]
30+
31+
**Additional context**
32+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature Request
3+
about: Suggest an idea for this project
4+
title: "[FEATURE] "
5+
labels: enhancement
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

‎.github/assets/README.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# GitHub Assets
2+
3+
This directory contains assets for the GitHub repository.
4+
5+
## Social Preview Image
6+
7+
The `social-preview.svg` file is a vector-based social preview image that can be converted to PNG format for use in GitHub repository settings.
8+
9+
### Converting SVG to PNG
10+
11+
You can convert the SVG to PNG using several methods:
12+
13+
#### Method 1: Online Converter
14+
1. Visit an online SVG to PNG converter (e.g., convertio.co, cloudconvert.com)
15+
2. Upload the `social-preview.svg` file
16+
3. Set output dimensions to 1280x640 pixels
17+
4. Download the PNG file
18+
5. Rename to `social-preview.png`
19+
20+
#### Method 2: Command Line (if you have ImageMagick)
21+
```bash
22+
convert social-preview.svg -resize 1280x640 social-preview.png
23+
```
24+
25+
#### Method 3: Using a browser
26+
1. Open the SVG file in a web browser
27+
2. Take a screenshot or use browser dev tools to save as PNG
28+
3. Ensure the dimensions are 1280x640 pixels
29+
30+
### Usage
31+
Once converted to PNG, upload the `social-preview.png` file to your GitHub repository's "Social preview" section in the repository settings.
32+
33+
### Design Details
34+
- **Dimensions**: 1280x640 pixels
35+
- **Theme**: Dark theme with blue accents
36+
- **Content**: "Attribution-Plugin" title with subtitle
37+
- **Style**: Modern, clean design suitable for social media sharing

‎.github/assets/social-preview.svg‎

Lines changed: 1 addition & 0 deletions
Loading

‎.github/workflows/ci.yml‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [ main, develop ]
6+
pull_request:
7+
branches: [ main ]
8+
9+
jobs:
10+
build:
11+
runs-on: ubuntu-latest
12+
13+
strategy:
14+
matrix:
15+
node-version: [16.x, 18.x, 20.x]
16+
17+
steps:
18+
- uses: actions/checkout@v4
19+
20+
- name: Use Node.js ${{ matrix.node-version }}
21+
uses: actions/setup-node@v4
22+
with:
23+
node-version: ${{ matrix.node-version }}
24+
cache: 'npm'
25+
26+
- name: Install dependencies
27+
run: npm ci
28+
29+
- name: Compile TypeScript
30+
run: npm run compile
31+
32+
- name: Check for compilation errors
33+
run: |
34+
if [ ! -f "out/extension.js" ]; then
35+
echo "Compilation failed - extension.js not found"
36+
exit 1
37+
fi
38+
39+
- name: Validate package.json
40+
run: |
41+
# Check if package.json is valid JSON
42+
node -e "JSON.parse(require('fs').readFileSync('package.json', 'utf8'))"
43+
44+
# Check required fields
45+
node -e "
46+
const pkg = JSON.parse(require('fs').readFileSync('package.json', 'utf8'));
47+
const required = ['name', 'displayName', 'version', 'engines', 'main', 'contributes'];
48+
const missing = required.filter(field => !pkg[field]);
49+
if (missing.length > 0) {
50+
console.error('Missing required fields:', missing);
51+
process.exit(1);
52+
}
53+
"
54+
55+
- name: Upload build artifacts
56+
uses: actions/upload-artifact@v4
57+
with:
58+
name: extension-build-${{ matrix.node-version }}
59+
path: out/
60+
retention-days: 7

‎CODE_OF_CONDUCT.md‎

Lines changed: 125 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,125 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
56+
## Enforcement
57+
58+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
59+
reported to the community leaders responsible for enforcement at
60+
[INSERT CONTACT METHOD].
61+
All complaints will be reviewed and investigated promptly and fairly.
62+
63+
All community leaders are obligated to respect the privacy and security of the
64+
reporter of any incident.
65+
66+
## Enforcement Guidelines
67+
68+
Community leaders will follow these Community Impact Guidelines in determining
69+
the consequences for any action they deem in violation of this Code of Conduct:
70+
71+
### 1. Correction
72+
73+
**Community Impact**: Use of inappropriate language or other behavior deemed
74+
unprofessional or unwelcome in the community.
75+
76+
**Consequence**: A private, written warning from community leaders, providing
77+
clarity around the nature of the violation and an explanation of why the
78+
behavior was inappropriate. A public apology may be requested.
79+
80+
### 2. Warning
81+
82+
**Community Impact**: A violation through a single incident or series
83+
of actions.
84+
85+
**Consequence**: A warning with consequences for continued behavior. No
86+
interaction with the people involved, including unsolicited interaction with
87+
those enforcing the Code of Conduct, for a specified period of time. This
88+
includes avoiding interactions in community spaces as well as external channels
89+
like social media. Violating these terms may lead to a temporary or
90+
permanent ban.
91+
92+
### 3. Temporary Ban
93+
94+
**Community Impact**: A serious violation of community standards, including
95+
sustained inappropriate behavior.
96+
97+
**Consequence**: A temporary ban from any sort of interaction or public
98+
communication with the community for a specified period of time. No public or
99+
private interaction with the people involved, including unsolicited interaction
100+
with those enforcing the Code of Conduct, is allowed during this period.
101+
Violating these terms may lead to a permanent ban.
102+
103+
### 4. Permanent Ban
104+
105+
**Community Impact**: Demonstrating a pattern of violation of community
106+
standards, including sustained inappropriate behavior, harassment of an
107+
individual, or aggression toward or disparagement of classes of individuals.
108+
109+
**Consequence**: A permanent ban from any sort of public interaction within
110+
the community.
111+
112+
## Attribution
113+
114+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
115+
version 2.0, available at
116+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
117+
118+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
119+
enforcement ladder](https://github.com/mozilla/diversity).
120+
121+
[homepage]: https://www.contributor-covenant.org
122+
123+
For answers to common questions about this code of conduct, see
124+
https://www.contributor-covenant.org/faq. Translations are available at
125+
https://www.contributor-covenant.org/translations.

0 commit comments

Comments
 (0)