Skip to content

Commit

Permalink
The initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
TGWolf committed Jun 4, 2024
0 parents commit 0a9dded
Show file tree
Hide file tree
Showing 33 changed files with 1,561 additions and 0 deletions.
5 changes: 5 additions & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
#
# These owners will be the default owners for everything in the repo.
#
* @TGWolf

75 changes: 75 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, sex characteristics, gender identity and expression,
level of experience, education, socio-economic status, nationality, personal
appearance, race, religion, or sexual identity and orientation.

## Our Standards

Examples of behaviour that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behaviour by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behaviour and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behaviour.

Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behaviour may be
reported by contacting the project team at . All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the
[Contributor Covenant](https://www.contributor-covenant.org), version 1.4,
available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>

For answers to common questions about this code of conduct, see
<https://www.contributor-covenant.org/faq>
14 changes: 14 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Contributing

Please refer to the
[contributing](https://github.com/WolfSoftware/contributing)
documentation.

## Important

ALL commits must be signed to ensure the identity of the developer, any pull
requests that are made with unsigned commits will be rejected as a matter of
course.

> This project has a [code of conduct](CODE_OF_CONDUCT.md). By interacting
with this repository, organization, or community you agree to abide by its terms.
4 changes: 4 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Funding
# https://help.github.com/en/github/administering-a-repository/displaying-a-sponsor-button-in-your-repository

github: [WolfSoftware,TGWolf]
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/ask_question.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: Ask a question
description: If you don't have a specific issue or bug to report you can still ask us questions and we will do our best to answer them
title: "[Question]: "
labels: ["type: question", "state: triage"]
assignees:
- tgwolf
body:
- type: textarea
id: question
attributes:
label: What is your question?
description: Please give us time to review your question and formulate an answer.
validations:
required: true
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/DevelopersToolbox/validate-json/blob/master/.github/CODE_OF_CONDUCT.md)
options:
- label: I agree to follow this project's Code of Conduct
required: true
58 changes: 58 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
name: Report a bug
description: Found a bug? Let us knonw what the issue is and we will attempt to fix it
title: "[Bug]: "
labels: ["type: bug", "state: triage"]
assignees:
- tgwolf
body:
- type: textarea
id: what-happened
attributes:
label: What happened?
description: A clear and concise description of what the bug is.
validations:
required: true
- type: textarea
id: expected-behavior
attributes:
label: Expected behavior
description: A clear and concise description of what you expected to happen.
validations:
required: true
- type: textarea
id: reproduce
attributes:
label: How do we reproduct the bug?
description: What are the steps we need to take to reproduce the behavior?
validations:
required: true
- type: textarea
id: logs
attributes:
label: Relevant log output
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
render: shell
validations:
required: false
- type: textarea
id: screenshoots
attributes:
label: Screeenshots
description: Upload any screenshots that might help demonstrate the bug.
validations:
required: false
- type: textarea
id: additional-information
attributes:
label: Additional information
description: Please provide any additional information that you think will help us to resolve this bug.
validations:
required: false
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/DevelopersToolbox/validate-json/blob/master/.github/CODE_OF_CONDUCT.md)
options:
- label: I agree to follow this project's Code of Conduct
required: true
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: Support us
url: https://ko-fi.com/wolfsoftware
about: Show your support
- name: Visit our website
url: https://wolfsoftware.com/
about: Visit the Wolf Software website and see what else we do and what services we offer
43 changes: 43 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
name: Request a new feature
description: Got an idea for a new feature? Let us know what you want and we will see if we can add it
title: "[Feature Request]: "
labels: ["type: feature", "state: triage"]
assignees:
- tgwolf
body:
- type: textarea
id: releated-to
attributes:
label: Is your feature request related to a problem?
description: A clear and concise description of what the problem is. E.g. I'm always frustrated when ...
validations:
required: true
- type: textarea
id: suggested-solution
attributes:
label: Suggested Solution
description: A clear and concise description of what you want to see implemented.
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Describe alternatives you've considered
description: A clear and concise description of any alternative solutions or features you've considered.
validations:
required: true
- type: textarea
id: additional-information
attributes:
label: Additional information
description: Please provide any additional information that you think will help us to resolve this bug.
validations:
required: false
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/DevelopersToolbox/validate-json/blob/master/.github/CODE_OF_CONDUCT.md)
options:
- label: I agree to follow this project's Code of Conduct
required: true
36 changes: 36 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Thank You

Thanks for submitting a pull request! Please provide enough information so that
others can review your pull request:

## Summary

<!-- Summary of the PR -->

This PR fixes/implements the following **bugs/features**

* [ ] Bug 1
* [ ] Feature 1
* [ ] Breaking changes

<!-- You can skip this if you're fixing a typo or adding an app to the
Showcase. -->

Explain the **motivation** for making this change. What existing problem does
the pull request solve?

<!-- Example: When "Adding a function to do X", explain why it is necessary
to have a way to do X. -->

## Test plan (required)

Demonstrate the code is solid. Example: The exact commands you ran and their
output, screenshots help greatly.

<!-- Make sure tests pass on both Travis. -->

## Closing issues

<!-- Put `fixes #NNN` in your comment to auto-close the issue that your PR
fixes (if such). -->
Fixes #
40 changes: 40 additions & 0 deletions .github/SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Security Policies and Procedures

This document outlines security procedures and general policies for this project.

* [Reporting a Bug](#reporting-a-bug)
* [Disclosure Policy](#disclosure-policy)
* [Comments on this Policy](#comments-on-this-policy)

## Reporting a Bug

We take **ALL** security related bugs and issues very seriously.

If you think you have identified a security related issue, please
[report it immediately](mailto:[email protected]) and include
the word "SECURITY" in the subject line. If you are not sure, don’t worry.
Better safe than sorry – just send an email.

* Please provide as much information as you can.
* Please do not open issues related to any security concerns publicly.
* Please do not include anyone else on the disclosure email.

Report security bugs in third-party modules to the person or team maintaining
the module.

## Disclosure Policy

When a security report is received, we will carry out the following steps:

* Confirm the problem and determine the affected versions.
* Audit code to find any potential similar problems.
* Prepare fixes for all releases still under maintenance. These fixes will be
released as fast as possible.

We will endeavour to keep you informed of the progress towards a fix and full
announcement, and may ask for additional information or guidance.

## Comments on this Policy

If you have suggestions on how this process could be improved please submit a
pull request.
18 changes: 18 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
version: 2

updates:
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "weekly"
day: "monday"
time: "04:00"
open-pull-requests-limit: 10
commit-message:
prefix: "chore:"
labels:
- "dependabot: ecosystem : github actions"
- "dependabot: dependencies"
assignees:
- "TGWolf"

38 changes: 38 additions & 0 deletions .github/scripts/check-jobs.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
#!/usr/bin/env bash

# This script receives a JSON string containing job results and checks for any failures.

# Check if jq is available
if ! command -v jq &> /dev/null; then
echo "jq could not be found, please install jq to run this script."
exit 1
fi

# Read the JSON string from the first script argument
job_results_json=$1

# Check if the job results JSON is not empty
if [[ -z "$job_results_json" ]]; then
echo "No job results JSON provided."
exit 1
fi

# Set default state
failed_jobs=false

# Use jq to parse the JSON and check each job's result
while IFS= read -r line; do
job_name=$(echo "$line" | awk '{print $1}')
result=$(echo "$line" | awk '{print $3}')

if [ "$result" != "success" ]; then
echo "$job_name failed."
failed_jobs=true
else
echo "$job_name succeed."
fi
done <<< "$( echo "$job_results_json" | jq -r 'to_entries[] | "\(.key) result: \(.value.result)"' )"

if [ "$failed_jobs" = true ] ; then
exit 1
fi
Loading

0 comments on commit 0a9dded

Please sign in to comment.