Skip to content

Commit 328bb7c

Browse files
committed
docs: add gh docs
0 parents  commit 328bb7c

10 files changed

+275
-0
lines changed

.github/CODEOWNERS

+60
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# This is a comment.
2+
# Each line is a file pattern followed by one or more owners.
3+
4+
# These owners will be the default owners for everything in
5+
# the repo. Unless a later match takes precedence,
6+
# @global-owner1 and @global-owner2 will be requested for
7+
# review when someone opens a pull request.
8+
* @tooniez
9+
10+
# Order is important; the last matching pattern takes the most
11+
# precedence. When someone opens a pull request that only
12+
# modifies JS files, only @js-owner and not the global
13+
# owner(s) will be requested for a review.
14+
*.js @tooniez #This is an inline comment.
15+
16+
# You can also use email addresses if you prefer. They'll be
17+
# used to look up users just like we do for commit author
18+
# emails.
19+
# *.go docs@example.com
20+
21+
# Teams can be specified as code owners as well. Teams should
22+
# be identified in the format @org/team-name. Teams must have
23+
# explicit write access to the repository. In this example,
24+
# the octocats team in the octo-org organization owns all .txt files.
25+
# *.txt @octo-org/octocats
26+
*.md @tooniez
27+
28+
# In this example, @doctocat owns any files in the build/logs
29+
# directory at the root of the repository and any of its
30+
# subdirectories.
31+
# /build/logs/ @doctocat
32+
33+
# The `docs/*` pattern will match files like
34+
# `docs/getting-started.md` but not further nested files like
35+
# `docs/build-app/troubleshooting.md`.
36+
# docs/* docs@example.com
37+
38+
# In this example, @octocat owns any file in an apps directory
39+
# anywhere in your repository.
40+
# apps/ @octocat
41+
42+
# In this example, @doctocat owns any file in the `/docs`
43+
# directory in the root of your repository and any of its
44+
# subdirectories.
45+
# /docs/ @doctocat
46+
47+
# In this example, any change inside the `/scripts` directory
48+
# will require approval from @doctocat or @octocat.
49+
# /scripts/ @doctocat @octocat
50+
51+
# In this example, @octocat owns any file in a `/logs` directory such as
52+
# `/build/logs`, `/scripts/logs`, and `/deeply/nested/logs`. Any changes
53+
# in a `/logs` directory will require approval from @octocat.
54+
# **/logs @octocat
55+
56+
# In this example, @octocat owns any file in the `/apps`
57+
# directory in the root of your repository except for the `/apps/github`
58+
# subdirectory, as its owners are left empty.
59+
# /apps/ @octocat
60+
# /apps/github

.github/CODE_OF_CONDUCT.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Code of Conduct 👮‍♂️
2+
3+
## Our Pledge 🤝
4+
5+
In order to maintain a respectful and inclusive community, we, as contributors and maintainers, pledge to:
6+
7+
- 👉 Respect all contributors regardless of their race, ethnicity, nationality, religion, sexual orientation, gender identity, age, skill level, or background.
8+
- 👉 Welcome constructive feedback and strive to learn from it.
9+
- 👉 Listen actively and be empathetic towards others’ perspectives.
10+
- 👉 Maintain a harassment-free environment, where all forms of discrimination, hate speech, and personal attacks are prohibited.
11+
- 👉 Use welcoming and inclusive language in all interactions and communications.
12+
- 👉 Prioritize the safety and comfort of all members of our community.
13+
- 👉 Hold ourselves accountable to these guidelines and consequences, if they are breached.
14+
15+
## Our Responsibilities 💪
16+
17+
As maintainers of this community, we are responsible for:
18+
- 👉 Clarifying the standards of acceptable behavior and enforcing them.
19+
- 👉 Using appropriate and fair moderation practices collaboratively.
20+
- 👉 Taking responsible action in any unethical situation.
21+
- 👉 Communicating the reasons for moderation decisions transparently.
22+
23+
We expect all contributors to uphold these standards and create a friendly and supportive environment. Together, we can build a community where everyone feels safe and valued. 🤝

.github/CONTRIBUTING.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# 🎉 Contributing Guidelines 🎉
2+
3+
Thank you for considering contributing to our project! 👏 We appreciate your time, effort, and contributions to make this project better. 🙌
4+
5+
Please take a moment to review the following guidelines before submitting a pull request: 📝
6+
7+
## 💻 Code of Conduct 🤝
8+
9+
We have adopted a Code of Conduct that we expect project participants to adhere to. 🤝 Please read the full text so that you can understand what actions and behaviors will not be tolerated. 😊
10+
11+
## 💡 Issues and Pull Requests 🤝
12+
13+
Please make sure to create a new issue before submitting a pull request. This will help us to understand the change you are proposing and to discuss the best way to implement it. 🤔
14+
15+
When creating a pull request, please ensure that your changes: 🛠️
16+
- Follow the style guide 📜
17+
- Include tests (if applicable) 🧪
18+
- Provide clear and concise commit messages 💬
19+
- Do not break the existing functionality of the project ❌
20+
- Add appropriate documentation (if applicable) 📚

.github/FUNDING.yml

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
github: [tooniez] # List of usernames to support funding on GitHub

.github/GOVERNANCE.md

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Governance Policy 🏛️
2+
3+
## Purpose 🎯
4+
The purpose of this policy is to establish guidelines and standards for the governance of our organization. 🤝
5+
6+
## Scope 🌎
7+
This policy applies to all employees and stakeholders of the organization. 👥
8+
9+
## Policy Statement 📜
10+
Our organization is committed to conducting its business in accordance with the highest ethical and legal standards. To this end, we have established the following governance policies:
11+
12+
### Compliance ✅
13+
We are committed to compliance with all applicable laws and regulations.
14+
15+
### Transparency 🔍
16+
We will be transparent in our operations and provide stakeholders with timely and accurate information.
17+
18+
### Risk Management 📊
19+
We will identify and manage risks to our organization, including financial, operational, and reputational risks.
20+
21+
### Accountability 🤲
22+
We will hold ourselves accountable for our actions and decisions.
23+
24+
### Ethics 🙌
25+
We will conduct ourselves in accordance with the highest ethical standards.
26+
27+
## Review and Revision 🔄
28+
This policy will be reviewed and revised as necessary to ensure its ongoing effectiveness and relevance to the organization's operations. 🧐
29+
30+
## Contacts 📞
31+
If you have any questions about this policy, please contact [insert contact information here]. 📧

.github/PRIVACY.md

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Data Privacy Policy 🔒
2+
3+
We respect the privacy of our users and are committed to protecting any personal information that we may collect. This policy explains our practices for handling and securing your data.
4+
5+
## Information We Collect 📝
6+
7+
We may collect the following information from our users:
8+
- 👉 Name
9+
- 👉 Email address
10+
- 👉 Phone number
11+
- 👉 Address
12+
- 👉 Payment information
13+
14+
We only collect this information when it is necessary for the purposes of providing our services or when users voluntarily provide it to us.
15+
16+
## How We Use Your Information 🗂️
17+
18+
We use your information for the following purposes:
19+
- 👉 Providing and improving our services
20+
- 👉 Billing and payment processing
21+
- 👉 Responding to user inquiries and support requests
22+
23+
We will never sell or share your personal information with any third parties unless we receive your explicit consent or are required by law to do so.
24+
25+
## Security Measures 🔒
26+
27+
We take reasonable precautions to protect your personal information from unauthorized access, use, or disclosure. However, no method of transmission over the internet or electronic storage is 100% secure, and we cannot guarantee absolute security.
28+
29+
## Retention of Data 🗃️
30+
31+
We will retain your personal information only for as long as necessary to provide our services or to comply with our legal obligations.
32+
33+
## Your Rights 🤝
34+
35+
You have the following rights regarding your personal information:
36+
- 👉 The right to access, update, or request deletion of your information
37+
- 👉 The right to object to the processing of your information
38+
- 👉 The right to request that we restrict the processing of your information
39+
- 👉 The right to data portability
40+
41+
To exercise any of these rights, please contact us using the contact information provided below.
42+
43+
## Changes to This Policy 📝
44+
45+
We may update this policy from time to time to reflect changes in our practices or legal requirements. We will notify you of any material changes by posting a notice on our website or by sending you an email.
46+
47+
## Contact Us 📞
48+
49+
If you have any questions or concerns about our data privacy policy, please contact us at [insert contact email/phone number/address].

.github/SECURITY.md

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Security Policy 🔒
2+
3+
## Purpose 🎯
4+
The purpose of this policy is to ensure the security of our organization's data and information.
5+
6+
## Scope 🌎
7+
This policy applies to all employees, contractors, and stakeholders who have access to our organization's information systems or data.
8+
9+
## Access Control 🔑
10+
Access to our organization's information systems and data will be granted on a need-to-know basis, with appropriate permissions and authentication measures in place.
11+
12+
## Security Measures 🛡️
13+
Our organization will implement and maintain appropriate technical and organizational security measures to protect against unauthorized access, disclosure, or loss of information.
14+
15+
## Incident Response 🚨
16+
Our organization will have an incident response plan in place to promptly and effectively respond to security incidents.
17+
18+
## Data Protection 📂
19+
Our organization will protect sensitive data through appropriate encryption, storage, and backup procedures.
20+
21+
## Third-Party Security 🤝
22+
Our organization will ensure that third-party contractors and vendors who handle our information or systems adhere to our security standards and policies.
23+
24+
## Training and Awareness 🎓
25+
Our organization will provide regular training and awareness programs to educate employees and stakeholders on security best practices and policies.
26+
27+
## Review and Revision 🔄
28+
This policy will be reviewed and revised as necessary to ensure its ongoing effectiveness and relevance to our organization's operations.
29+
30+
## Contact 📞
31+
If you have any questions about this policy, please contact [insert contact information here].

.github/SERVICE.md

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Terms of Service 📜
2+
3+
By accessing this website or using any of its services, you agree to be bound by these terms of service. If you do not agree with any of these terms, do not use the website or its services.
4+
5+
## User Conduct 🙋‍♂️
6+
7+
As a condition of your use of this website or its services, you agree to:
8+
- 👉 Provide accurate and complete information
9+
- 👉 Maintain the security of your account and password
10+
- 👉 Accept all risks of unauthorized access to your account and personal information
11+
- 👉 Not use the website or its services for any illegal or unauthorized purposes
12+
- 👉 Not interfere or disrupt the website or its services or servers or networks connected to the website
13+
- 👉 Comply with all applicable laws and regulations
14+
15+
## Intellectual Property 🖋️
16+
17+
The website and its original content, features, and functionality are owned by [company name] and are protected by international copyright, trademark, patent, trade secret, and other intellectual property or proprietary rights laws.
18+
19+
## Disclaimer of Warranties ❗
20+
21+
The website and its services are provided on an "as is" and "as available" basis. [Company name] makes no warranties, expressed or implied, and hereby disclaims and negates all other warranties including, without limitation, implied warranties or conditions of merchantability, fitness for a particular purpose, or non-infringement of intellectual property or other violation of rights.
22+
23+
## Limitation of Liability 💰
24+
25+
[Company name] shall not be liable for any damages whatsoever arising out of the use or inability to use the website or its services, including but not limited to direct, indirect, incidental, consequential, or punitive damages.
26+
27+
## Indemnification 👍
28+
29+
You agree to indemnify and hold harmless [company name], its affiliates, officers, agents, licensors, and employees from any claim or demand, including reasonable attorney's fees, made by any third party due to or arising out of your breach of these terms of service or your violation of any law or the rights of a third party.
30+
31+
## Termination and Modifications 🔚
32+
33+
[Company name] reserves the right to terminate your access to the website and its services at any time, without notice and for any reason. We may also modify these terms of service at any time, without notice, and such modifications will be effective immediately upon publishing.
34+
35+
## Governing Law 🏛️
36+
37+
These terms and conditions are governed by and construed in accordance with the laws of [country], and you irrevocably submit to the exclusive jurisdiction of the courts in that State or location.
38+
39+
## Contact Us 📞
40+
41+
If you have any questions or concerns about these terms of service, please contact us at [insert contact email/phone number/address].

.github/SUPPORT.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
### Getting Support 🤝
2+
We want to make sure that everyone who uses our product feels supported. If you need help or have any questions, please check out our support options below:
3+
4+
### Documentation 📖
5+
Our documentation includes an overview of the product, how to get started, frequently asked questions, troubleshooting tips, and more. Check it out at [insert URL here].
6+
7+
### Community Forum 💬
8+
Our community forum is a great place to ask questions and share your experiences with other users. It's a friendly and supportive space where you can get help from the community and our support team. Visit our forum at [insert URL here].
9+
10+
### Email Support 📧
11+
If you have a question that you can't find an answer to in our documentation or community forum, you can email our support team at [insert email address here]. We'll get back to you as soon as possible.
12+
13+
We're committed to providing the best support possible to our users. If you have any feedback on our support options or suggestions for how we can improve, please let us know.

.github/dependabot.yml

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: "github-actions"
4+
directory: "/"
5+
schedule:
6+
interval: "daily"

0 commit comments

Comments
 (0)