Skip to content

Commit 633adbe

Browse files
thegdsksthegdsks
committed
Docs Imporvement
1 parent a9927b0 commit 633adbe

File tree

4 files changed

+166
-2
lines changed

4 files changed

+166
-2
lines changed

‎.github/workflows/dependency-review.yml

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Dependency Review Action
2+
#
3+
# This Action will scan dependency manifest files that change as part of a Pull Request,
4+
# surfacing known-vulnerable versions of the packages declared or updated in the PR.
5+
# Once installed, if the workflow run is marked as required, PRs introducing known-vulnerable
6+
# packages will be blocked from merging.
7+
#
8+
# Source repository: https://github.com/actions/dependency-review-action
9+
# Public documentation: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review#dependency-review-enforcement
10+
name: "Dependency review"
11+
on:
12+
pull_request:
13+
branches: ["develop"]
14+
15+
# If using a dependency submission action in this workflow this permission will need to be set to:
16+
#
17+
# permissions:
18+
# contents: write
19+
#
20+
# https://docs.github.com/en/enterprise-cloud@latest/code-security/supply-chain-security/understanding-your-software-supply-chain/using-the-dependency-submission-api
21+
permissions:
22+
contents: read
23+
# Write permissions for pull-requests are required for using the `comment-summary-in-pr` option, comment out if you aren't using this option
24+
pull-requests: write
25+
26+
jobs:
27+
dependency-review:
28+
runs-on: ubuntu-latest
29+
steps:
30+
- name: "Checkout repository"
31+
uses: actions/checkout@v4
32+
- name: "Dependency Review"
33+
uses: actions/dependency-review-action@v4
34+
# Commonly enabled options, see https://github.com/actions/dependency-review-action#configuration-options for all available options.
35+
with:
36+
comment-summary-in-pr: always
37+
# fail-on-severity: moderate
38+
# deny-licenses: GPL-1.0-or-later, LGPL-2.0-or-later
39+
# retry-on-snapshot-warnings: true

‎CODE_OF_CONDUCT.md

+80
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
2+
# Contributor Covenant Code of Conduct
3+
4+
## Our Pledge
5+
6+
We as members, contributors, and leaders pledge to make participation in our 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, religion, or sexual identity and orientation.
7+
8+
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
9+
10+
## Our Standards
11+
12+
Examples of behavior that contributes to a positive environment for our community include:
13+
14+
* Demonstrating empathy and kindness toward other people
15+
* Being respectful of differing opinions, viewpoints, and experiences
16+
* Giving and gracefully accepting constructive feedback
17+
* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
18+
* Focusing on what is best not just for us as individuals, but for the overall community
19+
20+
Examples of unacceptable behavior include:
21+
22+
* The use of sexualized language or imagery, and sexual attention or advances of any kind
23+
* Trolling, insulting or derogatory comments, and personal or political attacks
24+
* Public or private harassment
25+
* Publishing others’ private information, such as a physical or email address, without their explicit permission
26+
* Other conduct which could reasonably be considered inappropriate in a professional setting
27+
28+
## Enforcement Responsibilities
29+
30+
Community leaders 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.
31+
32+
Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
33+
34+
## Scope
35+
36+
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
37+
38+
## Enforcement
39+
40+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [[email protected]]. All complaints will be reviewed and investigated promptly and fairly.
41+
42+
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
43+
44+
## Enforcement Guidelines
45+
46+
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
47+
48+
### 1. Correction
49+
50+
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
51+
52+
**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
53+
54+
### 2. Warning
55+
56+
**Community Impact**: A violation through a single incident or series of actions.
57+
58+
**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
59+
60+
### 3. Temporary Ban
61+
62+
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
63+
64+
**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
65+
66+
### 4. Permanent Ban
67+
68+
**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
69+
70+
**Consequence**: A permanent ban from any sort of public interaction within the community.
71+
72+
## Attribution
73+
74+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0, available at [https://www.contributor-covenant.org/version/2/0/code_of_conduct.html](https://www.contributor-covenant.org/version/2/0/code_of_conduct.html).
75+
76+
Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
77+
78+
For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq). Translations are available at [https://www.contributor-covenant.org/translations](https://www.contributor-covenant.org/translations).
79+
80+
[homepage]: https://www.contributor-covenant.org

‎PULL_REQUEST_TEMPLATE.md

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
## Pull Request Title
2+
3+
### Description
4+
5+
Please include a summary of the changes and the related issue(s) (if any). Highlight the main features, bug fixes, or improvements introduced by this PR.
6+
7+
- **What has changed?**
8+
- [ ] New feature
9+
- [ ] Bug fix
10+
- [ ] Documentation update
11+
- [ ] Other (describe)
12+
13+
### Related Issue(s)
14+
15+
Please link the related issue(s) that this pull request addresses.
16+
17+
Fixes # (issue)
18+
19+
### Changes Checklist
20+
21+
Please ensure your PR meets the following criteria:
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 on my code, particularly in hard-to-understand areas.
26+
- [ ] I have added tests that prove my fix is effective or that my feature works.
27+
- [ ] New and existing unit tests pass locally with my changes.
28+
- [ ] I have updated the documentation (if applicable).
29+
30+
### How Has This Been Tested?
31+
32+
Please describe the tests that you ran to verify your changes. Provide instructions to reproduce the testing scenarios if necessary.
33+
34+
- [ ] Test A
35+
- [ ] Test B
36+
37+
### Screenshots (if applicable)
38+
39+
If your changes involve visual updates, please add screenshots to help explain your work.
40+
41+
### Additional Comments
42+
43+
Add any additional information or context that might be important for the reviewer to know about your pull request.

‎README.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11

2-
# JSON-to-TypeScript Converter | @typeweaver/json2ts
2+
# JSON-to-TypeScript Converter
3+
## @typeweaver/json2ts
34

45
Convert JSON to TypeScript interfaces effortlessly.
56
An open-source tool for developers to generate TypeScript types from JSON objects quickly and securely.
@@ -117,8 +118,9 @@ By using the software in any form, you agree to adhere to the terms of both the
117118

118119
## 🌟 Acknowledgments
119120

120-
- Developed by [Glincker](https ://github.com/glincker).
121+
- Developed by [Glincker](https://github.com/glincker).
121122
- Part of the **GLINR** ecosystem.
123+
- Managed by [TypeWeaver](https://typeweaver.com)
122124

123125
---
124126

0 commit comments

Comments
 (0)