Skip to content

Commit df6648b

Browse files
n4vrl0s3n4vrl0s3
committed
Requirements
1 parent 2ebbaec commit df6648b

6 files changed

+274
-0
lines changed

‎CODE_OF_CONDUCT.md

+128
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
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.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
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
27+
28+
Examples of unacceptable behavior include:
29+
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
38+
39+
## Enforcement Responsibilities
40+
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.
45+
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.
50+
51+
## Scope
52+
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.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
[email protected].
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
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:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
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.
82+
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.
94+
95+
### 3. Temporary Ban
96+
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.
105+
106+
### 4. Permanent Ban
107+
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
116+
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.
120+
121+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122+
enforcement ladder](https://github.com/mozilla/diversity).
123+
124+
[homepage]: https://www.contributor-covenant.org
125+
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.

‎CONTRIBUTING.md

+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# Contribution Guide
2+
3+
Thank you for your interest in contributing to this project! Your contributions can help make this project better. Here are some guidelines to help you get started.
4+
5+
## How to Contribute
6+
7+
1. Fork this repository:
8+
- Click the `Fork` button at the top of this repository page.
9+
2. Clone the forked repository to your local machine.
10+
```bash
11+
git clone https://github.com/username/CMD-cURL.git
12+
```
13+
- Replace `username` with your GitHub username.
14+
3. Create a new branch
15+
- Create a new branch for the feature or fix you want to add.
16+
```
17+
cd CMD-cURL
18+
git checkout -b your-branch-name
19+
```
20+
- Use a descriptive branch name that reflects the feature or fix you are working on.
21+
4. Make the necessary changes:
22+
- Add or modify your code.
23+
5. Commit your changes:
24+
- Make sure to write a clear and descriptive commit message.
25+
```
26+
git add .
27+
git commit -m "Brief description of the changes you made"
28+
```
29+
6. Push to your repository:
30+
- Push your branch to your GitHub repository.
31+
```
32+
git push origin your-branch-name
33+
```
34+
7. Create a Pull Request (PR):
35+
- Go to the original repository page and create a pull request from your branch.
36+
- Provide a clear description of what you added or fixed in your pull request.
37+
38+
## Coding Guidelines
39+
40+
- Follow a consistent coding standard: Ensure your code is consistent with the existing code style in this project.
41+
- Write clear documentation: Add necessary comments and documentation to help others understand your code.
42+
- Write tests: If possible, add tests for the features or fixes you are adding.
43+
44+
## Reporting Issues
45+
46+
If you find any bugs or have suggestions for improvements, please create a new issue on the Issues page.
47+
48+
## Communication
49+
50+
If you want to discuss something related to your contribution or the project in general, feel free to reach out to us via [Discussions](https://github.com/guanshiyin28/CMD-cURL/discussions).
51+
52+
<br>
53+
Thank you for your contribution!

‎LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 Guan
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎PULL_REQUEST_TEMPLATE.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Description
2+
3+
Please describe the changes you have made.
4+
5+
## Type of Change
6+
7+
- [ ] Bug fix
8+
- [ ] New feature
9+
- [ ] Breaking change
10+
- [ ] Documentation update
11+
12+
## Checklist
13+
14+
- [ ] I have read the [CONTRIBUTING.md](CONTRIBUTING.md)
15+
- [ ] Tests have been added to verify that the changes are correct
16+
- [ ] All local tests pass (including code style checks)

‎README.md

+23
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,22 @@ Doing something fun with cURL.
1515

1616
<hr><br>
1717

18+
## Features
19+
20+
- Fetch web pages
21+
- Download and upload files
22+
- Make HTTP requests
23+
- Test APIs
24+
25+
<hr><br>
26+
27+
## Technologies Used
28+
29+
- cURL
30+
- Shell scripting
31+
32+
<hr><br>
33+
1834
## How to Run
1935

2036
1. Just start it
@@ -23,6 +39,13 @@ Doing something fun with cURL.
2339

2440
![1](https://github.com/user-attachments/assets/77e66fea-47b4-45ab-afb2-8265f0fdd9b0)
2541
</div>
42+
43+
<hr><br>
44+
45+
## License
46+
47+
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
48+
2649
<hr><br>
2750

2851
<div align=center>

‎SECURITY.md

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Security Policy
2+
3+
## Reporting a Vulnerability
4+
5+
If you discover a security vulnerability within this repository, please follow these steps:
6+
7+
1. **Do not disclose the vulnerability publicly.**
8+
- Publicly disclosing a vulnerability can put users at risk. Please refrain from sharing the details of the vulnerability in public forums, issue trackers, or any other public channels.
9+
10+
2. **Send an email to the security team.**
11+
- Please report the vulnerability to our security team via email at [[email protected]]. Include as much detail as possible about the vulnerability and any potential fixes.
12+
13+
3. **Provide detailed information.**
14+
- When reporting the vulnerability, please include the following information:
15+
- A description of the vulnerability and its impact.
16+
- Steps to reproduce the vulnerability.
17+
- Any potential fixes or suggestions for mitigation.
18+
19+
4. **Expect a response within 48 hours.**
20+
- We will acknowledge receipt of your report within 48 hours and will provide a detailed response within 7 days, including an estimate for when a fix will be implemented.
21+
22+
5. **Receive recognition for your contribution.**
23+
- Once the vulnerability is resolved, we will credit you for your discovery in the release notes, unless you prefer to remain anonymous.
24+
25+
## Security Update Policy
26+
27+
We will issue security updates for supported versions of our project as soon as possible after a vulnerability is reported and verified. Our goal is to ensure the safety and security of our users at all times.
28+
29+
---
30+
31+
By following this Security Policy, you help us maintain a secure and reliable project for everyone. Thank you for your cooperation and contribution to the security of our project.
32+
33+
If you have any questions or need further assistance, please contact us at [[email protected]].

0 commit comments

Comments
 (0)