Skip to content

Commit 71f3c0b

Browse files
Updated files
1 parent bb29e2d commit 71f3c0b

File tree

5 files changed

+88
-145
lines changed

5 files changed

+88
-145
lines changed

.github/pull_request_template.yml renamed to .github/pull_request_template.md

+3-11
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ title: "[Issue ID] | PR Title"
66
[Issue ID] | Short description of the changes made
77
-->
88

9-
**Discord Username:** @<your-username>
9+
**Discord Username:** @<your_username>
1010

1111
---
1212

@@ -24,17 +24,8 @@ title: "[Issue ID] | PR Title"
2424
<!-- Please include a summary of the changes made and what issue is fixed.
2525
Also provide relevant context and list any dependencies required for the change. -->
2626

27-
---
28-
29-
## Related Tickets & Documents
30-
- Related Issue: #
31-
- Closes: #
32-
33-
---
34-
3527
## QA Instructions, Screenshots, Recordings
36-
<!-- Provide detailed instructions on how the reviewer can test your changes.
37-
Mention any devices or browsers used for testing, and include screenshots or recordings if applicable. -->
28+
<!-- Provide detailed instructions on how the reviewer can test your changes. Mention any devices or browsers used for testing, and include screenshots or recordings if applicable. -->
3829

3930
---
4031

@@ -44,6 +35,7 @@ Mention any devices or browsers used for testing, and include screenshots or rec
4435
---
4536

4637
## Added/Updated Tests?
38+
4739
- [ ] 👍 Yes
4840
- [ ] 🙅 No, not needed
4941
- [ ] 🙋 No, but I need help

CODE_OF_CONDUCT.md

+40-95
Original file line numberDiff line numberDiff line change
@@ -1,128 +1,73 @@
1-
# Contributor Covenant Code of Conduct
1+
# Code of Conduct
22

3-
## Our Pledge
3+
## Our Pledge
44

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.
5+
We, as members, contributors, and leaders, are committed to making participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
116

12-
We pledge to act and interact in ways that contribute to an open, welcoming,
13-
diverse, inclusive, and healthy community.
7+
We pledge to act and interact in ways that foster an open, welcoming, diverse, inclusive, and healthy community.
148

15-
## Our Standards
9+
## Our Standards
1610

17-
Examples of behavior that contributes to a positive environment for our
18-
community include:
11+
Examples of behavior that contributes to a positive environment include:
1912

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
13+
- Showing empathy, kindness, and respect toward others
14+
- Welcoming differing opinions, experiences, and feedback
15+
- Gracefully accepting constructive criticism
16+
- Taking responsibility and apologizing for mistakes, with a commitment to improvement
17+
- Prioritizing community well-being over personal benefit
2718

28-
Examples of unacceptable behavior include:
19+
Examples of unacceptable behavior include:
2920

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
21+
- Using sexualized language or imagery, or making inappropriate advances
22+
- Engaging in trolling, insults, or derogatory remarks
23+
- Harassing or intimidating others, publicly or privately
24+
- Publishing someone’s private information without consent
25+
- Conduct that is inappropriate for a professional environment
3826

39-
## Enforcement Responsibilities
27+
## Enforcement Responsibilities
4028

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.
29+
Community leaders are responsible for defining and enforcing standards of behavior. They will take fair, corrective action in response to violations, including moderating contributions or interactions that conflict with this Code of Conduct.
4530

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.
31+
Leaders have the authority to remove or reject comments, commits, issues, or other contributions that do not align with community standards and will communicate the rationale for moderation decisions when appropriate.
5032

51-
## Scope
33+
## Scope
5234

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-
Examples of representing our community include using an official e-mail address,
56-
posting via an official social media account, or acting as an appointed
57-
representative at an online or offline event.
35+
This Code of Conduct applies to all community spaces and extends to interactions where an individual represents the project in public. This includes official social media accounts, public events, or any communication carried out on behalf of the project.
5836

59-
## Enforcement
37+
## Reporting Violations
6038

61-
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62-
reported to the community leaders responsible for enforcement at
63-
64-
All complaints will be reviewed and investigated promptly and fairly.
39+
If you witness or experience behavior that violates this Code of Conduct, please report it to the project maintainers at **[[email protected]](mailto:[email protected])**. All reports will be handled confidentially and promptly.
6540

66-
All community leaders are obligated to respect the privacy and security of the
67-
reporter of any incident.
41+
We are committed to protecting the privacy and safety of reporters.
6842

69-
## Enforcement Guidelines
43+
## Enforcement Guidelines
7044

71-
Community leaders will follow these Community Impact Guidelines in determining
72-
the consequences for any action they deem in violation of this Code of Conduct:
45+
Community leaders will use the following guidelines when determining the consequences of violations:
7346

7447
### 1. Correction
7548

76-
**Community Impact**: Use of inappropriate language or other behavior deemed
77-
unprofessional or unwelcome in the community.
49+
**Community Impact**: Use of inappropriate language or behavior considered unprofessional or unwelcome.
50+
**Consequence**: A private warning with clarification of the issue and a request for correction.
7851

79-
**Consequence**: A private, written warning from community leaders, providing
80-
clarity around the nature of the violation and an explanation of why the
81-
behavior was inappropriate. A public apology may be requested.
52+
### 2. Warning
8253

83-
### 2. Warning
84-
85-
**Community Impact**: A violation through a single incident or series
86-
of actions.
87-
88-
**Consequence**: A warning with consequences for continued behavior. No
89-
interaction with the people involved, including unsolicited interaction with
90-
those enforcing the Code of Conduct, for a specified period of time. This
91-
includes avoiding interactions in community spaces as well as external channels
92-
like social media. Violating these terms may lead to a temporary or
93-
permanent ban.
54+
**Community Impact**: A minor or repeated violation.
55+
**Consequence**: A warning with specific conditions for future participation. Continued misconduct may result in a temporary or permanent ban.
9456

9557
### 3. Temporary Ban
9658

97-
**Community Impact**: A serious violation of community standards, including
98-
sustained inappropriate behavior.
99-
100-
**Consequence**: A temporary ban from any sort of interaction or public
101-
communication with the community for a specified period of time. No public or
102-
private interaction with the people involved, including unsolicited interaction
103-
with those enforcing the Code of Conduct, is allowed during this period.
104-
Violating these terms may lead to a permanent ban.
59+
**Community Impact**: A serious violation or ongoing inappropriate behavior.
60+
**Consequence**: A temporary ban from community spaces. Any violation during the ban period may result in a permanent ban.
10561

10662
### 4. Permanent Ban
10763

108-
**Community Impact**: Demonstrating a pattern of violation of community
109-
standards, including sustained inappropriate behavior, harassment of an
110-
individual, or aggression toward or disparagement of classes of individuals.
111-
112-
**Consequence**: A permanent ban from any sort of public interaction within
113-
the community.
114-
115-
## Attribution
64+
**Community Impact**: Sustained inappropriate behavior or severe misconduct, such as harassment or targeting specific individuals or groups.
65+
**Consequence**: Permanent removal from the community.
11666

117-
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118-
version 2.0, available at
119-
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
67+
## Attribution
12068

121-
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122-
enforcement ladder](https://github.com/mozilla/diversity).
69+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.0.
12370

124-
[homepage]: https://www.contributor-covenant.org
71+
For more information, visit the [Contributor Covenant FAQ](https://www.contributor-covenant.org/faq).
12572

126-
For answers to common questions about this code of conduct, see the FAQ at
127-
https://www.contributor-covenant.org/faq. Translations are available at
128-
https://www.contributor-covenant.org/translations.
73+
---

CONTRIBUTING.md

-4
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,3 @@ git pull upstream main
5555
Before submitting a **Pull Request**, you should
5656

5757
1. Check your code safety with Linter and TypeScript, and make sure your code can build successfully.
58-
59-
```sh
60-
npm run pr:precheck
61-
```

README.md

+15-19
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,55 @@
11
# open source Template 🧪
22

3+
This is a basic template for an open-source project. Feel free to use it in future projects to save time and avoid starting from scratch.
4+
35
## Template to comment while bug fixing
46

57
Here are several templates you can use to close issues in a similar format to your example:
68

79
### Template 1
810

9-
**Bug Fixed by @username**
11+
**Bug Fixed by @username**
1012

11-
The reported bug has been addressed and successfully fixed by @username.
12-
Thank you for your contribution!
13+
The reported bug has been addressed and successfully fixed by @username. Thank you for your contribution!.
1314

1415
---
1516

1617
### Template 2
1718

18-
**Issue Resolved by @username**
19+
**Issue Resolved by @username**
1920

20-
The issue has been resolved thanks to @username.
21-
We appreciate your efforts!
21+
The issue has been resolved thanks to @username. We appreciate your efforts!
2222

2323
---
2424

2525
### Template 3
2626

27-
**Bug Resolved by @username**
27+
**Bug Resolved by @username**
2828

29-
The bug has been fixed by @username.
30-
Thank you for your timely intervention!
29+
The bug has been fixed by @username. Thank you for your timely intervention!
3130

3231
---
3332

3433
### Template 4
3534

36-
**Fix Implemented by @username**
35+
**Fix Implemented by @username**
3736

38-
The bug has been addressed and is now fixed by @username.
39-
Thank you for your help!
37+
The bug has been addressed and is now fixed by @username. Thank you for your help!
4038

4139
---
4240

4341
### Template 5
4442

45-
**Issue Closed: Fix by @username**
43+
**Issue Closed: Fix by @username**
4644

47-
The issue has been closed after being fixed by @username.
48-
Thank you for your valuable contribution!
45+
The issue has been closed after being fixed by @username. Thank you for your valuable contribution!
4946

5047
---
5148

5249
### Template 6
5350

54-
**Bug Addressed by @username**
51+
**Bug Addressed by @username**
5552

56-
The bug has been fixed by @username.
57-
Thank you for your hard work!
53+
The bug has been fixed by @username. Thank you for your hard work!
5854

59-
---
55+
---

SECURITY.md

+30-16
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,38 @@
1-
# Security Policy
1+
# Security
22

3-
- This is a test security policy
3+
We take the security of our software seriously. If you discover a security vulnerability in this project, please follow the instructions below to report it responsibly.
44

5+
## Reporting Security Issues
56

6-
## Supported Versions
7+
**Do not report vulnerabilities through public issue trackers.**
78

8-
Use this section to tell people about which versions of your project are
9-
currently being supported with security updates.
9+
Instead, please report them via email to:
10+
1011

11-
| Version | Supported |
12-
| ------- | ------------------ |
13-
| 5.1.x | :white_check_mark: |
14-
| 5.0.x | :x: |
15-
| 4.0.x | :white_check_mark: |
16-
| < 4.0 | :x: |
12+
To protect sensitive information, consider encrypting your message using PGP if applicable.
1713

18-
## Reporting a Vulnerability
14+
### Information to Include in Your Report
1915

20-
Use this section to tell people how to report a vulnerability.
16+
Providing the following details (where applicable) will help us assess the issue more effectively:
2117

22-
Tell them where to go, how often they can expect to get an update on a
23-
reported vulnerability, what to expect if the vulnerability is accepted or
24-
declined, etc.
18+
- **Type of issue** (e.g., buffer overflow, SQL injection, cross-site scripting, etc.)
19+
- **Affected file paths** or components
20+
- **Location of the issue** (branch/commit/tag or direct URL)
21+
- **Configuration details** required to reproduce the issue
22+
- **Step-by-step instructions** to reproduce the vulnerability
23+
- **Proof-of-concept or exploit code** (if available)
24+
- **Impact assessment**, including how an attacker could exploit the issue
25+
26+
We appreciate your effort in identifying security issues. Thank you for helping us maintain the safety and reliability of this project!
27+
28+
## Response Time
29+
30+
We aim to respond to vulnerability reports within **24 hours**. If you don’t receive a response, feel free to follow up to ensure your message was received.
31+
32+
## Preferred Language
33+
34+
We prefer all communication in **English**.
35+
36+
---
37+
38+
This version is stripped of project-specific references, with a placeholder email and general information that can be easily adapted to any project.

0 commit comments

Comments
 (0)