Skip to content

Commit d7965f3

Browse files
ulises-jeremiasulises-jeremias
committed
Update README.md for clarity and formatting improvements
1 parent 81c19f6 commit d7965f3

23 files changed

+2084
-0
lines changed

‎.cspell.json

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{
2+
"ignorePaths": [
3+
"**/node_modules/**",
4+
"**/vscode-extension/**",
5+
"**/.git/**",
6+
"**/.pnpm-lock.json",
7+
".vscode",
8+
"megalinter",
9+
"package-lock.json",
10+
"report"
11+
],
12+
"language": "en",
13+
"noConfigSearch": true,
14+
"words": ["megalinter", "oxsecurity"],
15+
"version": "0.2"
16+
}

‎.github/CODEOWNERS

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @ulises-jeremias

‎.github/CODE_OF_CONDUCT.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Code of Conduct
2+
3+
This code of conduct is derived from the Ruby code of conduct. This document provides community guidelines for a safe, respectful, productive, and collaborative place for any person who is willing to contribute to this community. It applies to all “collaborative space”, which is defined as community communications channels. Any violations of the code of conduct may be reported by contacting one or more of the project maintainers either directly.
4+
5+
- Participants will be tolerant of opposing views.
6+
- Participants must ensure that their language and actions are free of personal attacks and disparaging personal remarks.
7+
- When interpreting the words and actions of others, participants should always assume good intentions.
8+
- Behaviour that the project maintainers consider to be harassment will not be tolerated.

‎.github/FUNDING.yml

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# These are supported funding model platforms
2+
3+
github: ulises-jeremias # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
4+
patreon: # Replace with a single Patreon username
5+
open_collective: # Replace with a single Open Collective username
6+
ko_fi: # Replace with a single Ko-fi username
7+
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
8+
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
9+
liberapay: # Replace with a single Liberapay username
10+
issuehunt: # Replace with a single IssueHunt username
11+
otechie: # Replace with a single Otechie username
12+
lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
13+
custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

‎.github/ISSUE_TEMPLATE/bug-report.yml

+75
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
---
2+
name: "🐛 Bug Report"
3+
description: Report a bug
4+
title: "(short issue description)"
5+
labels: [bug]
6+
assignees: []
7+
body:
8+
- type: textarea
9+
id: description
10+
attributes:
11+
label: Describe the bug
12+
description: What is the problem? A clear and concise description of the bug.
13+
validations:
14+
required: true
15+
- type: textarea
16+
id: expected
17+
attributes:
18+
label: Expected Behavior
19+
description: |
20+
What did you expect to happen?
21+
validations:
22+
required: true
23+
- type: textarea
24+
id: current
25+
attributes:
26+
label: Current Behavior
27+
description: |
28+
What actually happened?
29+
30+
Please include full errors, uncaught exceptions, stack traces, and relevant logs.
31+
If service/functions responses are relevant, please include wire logs.
32+
validations:
33+
required: true
34+
- type: textarea
35+
id: reproduction
36+
attributes:
37+
label: Reproduction Steps
38+
description: |
39+
Provide a self-contained, concise snippet of code that can be used to reproduce the issue.
40+
For more complex issues provide a repo with the smallest sample that reproduces the bug.
41+
42+
Avoid including business logic or unrelated code, it makes diagnosis more difficult.
43+
The code sample should be an SSCCE. See http://sscce.org/ for details. In short, please provide a code sample that we can copy/paste, run and reproduce.
44+
validations:
45+
required: true
46+
- type: textarea
47+
id: solution
48+
attributes:
49+
label: Possible Solution
50+
description: |
51+
Suggest a fix/reason for the bug
52+
validations:
53+
required: false
54+
- type: textarea
55+
id: context
56+
attributes:
57+
label: Additional Information/Context
58+
description: |
59+
Anything else that might be relevant for troubleshooting this bug. Providing context helps us come up with a solution that is most useful in the real world.
60+
validations:
61+
required: false
62+
- type: input
63+
id: version
64+
attributes:
65+
label: Version used
66+
description: |
67+
Please provide the version of the repository or tool you are using.
68+
validations:
69+
required: true
70+
- type: input
71+
id: environment
72+
attributes:
73+
label: Environment details (OS name and version, etc.)
74+
validations:
75+
required: true

‎.github/ISSUE_TEMPLATE/documentation.yml

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: "📕 Documentation Issue"
2+
description: Report an issue in the Reference documentation or Developer Guide
3+
title: "(short issue description)"
4+
labels: [documentation]
5+
assignees: []
6+
body:
7+
- type: textarea
8+
id: description
9+
attributes:
10+
label: Describe the issue
11+
description: A clear and concise description of the issue.
12+
validations:
13+
required: true
14+
15+
- type: textarea
16+
id: links
17+
attributes:
18+
label: Links
19+
description: |
20+
Include links to affected documentation page(s).
21+
validations:
22+
required: true

‎.github/ISSUE_TEMPLATE/feature-request.yml

+61
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
---
2+
name: 🚀 Feature Request
3+
description: Suggest an idea for this project
4+
title: "(short issue description)"
5+
labels: [feature-request]
6+
assignees: []
7+
body:
8+
- type: textarea
9+
id: description
10+
attributes:
11+
label: Describe the feature
12+
description: A clear and concise description of the feature you are proposing.
13+
validations:
14+
required: true
15+
- type: textarea
16+
id: use-case
17+
attributes:
18+
label: Use Case
19+
description: |
20+
Why do you need this feature? For example: "I'm always frustrated when..."
21+
validations:
22+
required: true
23+
- type: textarea
24+
id: solution
25+
attributes:
26+
label: Proposed Solution
27+
description: |
28+
Suggest how to implement the addition or change. Please include prototype/workaround/sketch/reference implementation.
29+
validations:
30+
required: false
31+
- type: textarea
32+
id: other
33+
attributes:
34+
label: Other Information
35+
description: |
36+
Any alternative solutions or features you considered, a more detailed explanation, stack traces, related issues, links for context, etc.
37+
validations:
38+
required: false
39+
- type: checkboxes
40+
id: ack
41+
attributes:
42+
label: Acknowledgements
43+
options:
44+
- label: I may be able to implement this feature request
45+
required: false
46+
- label: This feature might incur a breaking change
47+
required: false
48+
- type: input
49+
id: version
50+
attributes:
51+
label: Version used
52+
description: |
53+
Please provide the version of the repository or tool you are using.
54+
validations:
55+
required: true
56+
- type: input
57+
id: environment
58+
attributes:
59+
label: Environment details (OS name and version, etc.)
60+
validations:
61+
required: true

‎.github/PULL_REQUEST_TEMPLATE.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
## Description
2+
3+
Please include a summary of the changes and the related issue. List any dependencies that are required for this change.
4+
5+
Fixes # (issue)
6+
7+
## Type of Change
8+
9+
- [ ] Bug fix (non-breaking change which fixes an issue)
10+
- [ ] New feature (non-breaking change which adds functionality)
11+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
12+
- [ ] Documentation update
13+
14+
## How Has This Been Tested?
15+
16+
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce.
17+
18+
- [ ] Test A
19+
- [ ] Test B
20+
21+
## Checklist
22+
23+
- [ ] My code follows the style guidelines of this project
24+
- [ ] I have performed a self-review of my code
25+
- [ ] I have commented my code, particularly in hard-to-understand areas
26+
- [ ] I have made corresponding changes to the documentation
27+
- [ ] My changes generate no new warnings
28+
- [ ] Any dependent changes have been merged and published in downstream modules
29+
- [ ] I have checked my code and corrected any misspellings

‎.github/dependabot.yml

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# To get started with Dependabot version updates, you'll need to specify which
2+
# package ecosystems to update and where the package manifests are located.
3+
# Please see the documentation for more information:
4+
# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
5+
# https://containers.dev/guide/dependabot
6+
7+
version: 2
8+
updates:
9+
- package-ecosystem: "devcontainers"
10+
directory: "/"
11+
schedule:
12+
interval: weekly
13+
- package-ecosystem: "github-actions"
14+
directory: "/"
15+
schedule:
16+
interval: weekly

‎.github/workflows/danger.yml

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: Pull Request Validation
2+
3+
concurrency:
4+
group: pull_request_${{ github.event.number }}
5+
cancel-in-progress: true
6+
7+
on:
8+
pull_request:
9+
10+
jobs:
11+
pr-review:
12+
name: Danger JS
13+
14+
if: github.event_name == 'pull_request' && github.event.pull_request.draft == false
15+
16+
runs-on: ubuntu-latest
17+
18+
permissions:
19+
contents: read
20+
pull-requests: write
21+
22+
steps:
23+
- name: Begin CI...
24+
uses: actions/checkout@v4
25+
26+
- uses: actions/setup-node@v4
27+
with:
28+
node-version-file: ./tools/danger/.node-version
29+
30+
- name: Setup Danger Files
31+
run: |
32+
echo "Setting up Danger files..."
33+
mv tools/danger/* .
34+
35+
- name: Install dependencies
36+
run: pnpm install --frozen-lockfile
37+
38+
- name: Danger JS Action
39+
uses: danger/[email protected]
40+
env:
41+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
42+
DANGER_GITHUB_API_TOKEN: ${{ secrets.DANGER_GITHUB_API_TOKEN }}

‎.github/workflows/todo.yml

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name: Todo Checker
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
8+
permissions:
9+
contents: read
10+
11+
jobs:
12+
todo:
13+
runs-on: ubuntu-latest
14+
15+
steps:
16+
- name: Begin CI...
17+
uses: actions/checkout@v4
18+
19+
- name: TODO to Issue
20+
uses: alstr/todo-to-issue-action@v5
21+
id: todo

‎.gitignore

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Local .terraform directories
2+
**/.terraform/*
3+
4+
# .tfstate files
5+
*.tfstate
6+
*.tfstate.*
7+
8+
# Crash log files
9+
crash.log
10+
11+
# Exclude all .tfvars files, which are likely to contain sensitive data, such as
12+
# password, private keys, and other secrets. These should not be part of version
13+
# control as they are data points which are potentially sensitive and subject
14+
# to change depending on the environment.
15+
# *.tfvars
16+
# *.tfvars.json
17+
18+
# Ignore override files as they are usually used to override resources locally and so
19+
# are not checked in
20+
override.tf
21+
override.tf.json
22+
*_override.tf
23+
*_override.tf.json
24+
25+
# Include override files you do wish to add to version control using negated pattern
26+
#
27+
# !example_override.tf
28+
29+
# Include tfplan files to ignore the plan output of command: terraform plan -out tfplan
30+
# example: *tfplan*
31+
*tfplan*
32+
33+
*.pem
34+
35+
.kubeconfig
36+
.envrc
37+
38+
megalinter-reports/

‎.jscpd.json

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
{
2+
"threshold": 0,
3+
"reporters": ["html", "markdown"],
4+
"ignore": [
5+
"**/node_modules/**",
6+
"**/.git/**",
7+
"**/.rbenv/**",
8+
"**/.venv/**",
9+
"**/*cache*/**",
10+
"**/.github/**",
11+
"**/.idea/**",
12+
"**/report/**",
13+
"**/*.svg"
14+
]
15+
}

‎.markdownlint.json

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"MD041": false,
3+
"MD042": false,
4+
"MD004": false,
5+
"MD013": false,
6+
"MD033": false,
7+
"MD024": false,
8+
"MD029": false,
9+
"MD053": false,
10+
"MD051": false
11+
}

0 commit comments

Comments
 (0)