Skip to content

Commit a96718a

Browse files
king04amanking04aman
committed
Init Repo with required files
1 parent 15ac6eb commit a96718a

File tree

5 files changed

+274
-0
lines changed

5 files changed

+274
-0
lines changed

‎CODE_OF_CONDUCT.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
5+
6+
## Our Standards
7+
Examples of behavior that contributes to creating a positive environment include:
8+
9+
- Using welcoming and inclusive language
10+
- Being respectful of differing viewpoints and experiences
11+
- Gracefully accepting constructive criticism
12+
- Focusing on what is best for the community
13+
- Showing empathy towards other community members
14+
15+
Examples of unacceptable behavior by participants include:
16+
17+
- The use of sexualized language or imagery and unwelcome sexual attention or advances
18+
- Trolling, insulting/derogatory comments, and personal or political attacks
19+
- Public or private harassment
20+
- Publishing others' private information, such as a physical or electronic address, without explicit permission
21+
- Other conduct which could reasonably be considered inappropriate in a professional setting
22+
23+
## Enforcement Responsibilities
24+
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
25+
26+
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, and will communicate reasons for moderation decisions when appropriate.
27+
28+
## Scope
29+
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.
30+
31+
## Enforcement
32+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [comingSoon@email.com]. 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.
33+
34+
## Attribution
35+
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/.

‎CONTRIBUTING.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# Contributing to All-In-One-Javascript-Projects
2+
3+
Thank you for considering contributing to the All-In-One-Javascript-Projects! Your contributions are what make this project a valuable resource for the community.
4+
5+
## How to Contribute
6+
7+
### 1. Fork the Repository
8+
- Click on the "Fork" button at the top right of the repository page to create a copy of the repository in your own GitHub account.
9+
10+
### 2. Create an Issue
11+
- Before making any changes, please check the existing issues or create a new issue describing what you plan to work on. This helps avoid duplicate efforts and keeps everyone informed.
12+
13+
### 3. Select a Project
14+
- You can choose to work on an existing project or propose a new one. If you propose a new project, ensure it aligns with the repository's goals.
15+
16+
### 4. Make Your Changes
17+
- Clone your forked repository to your local machine:
18+
```bash
19+
git clone https://github.com/your-username/All-In-One-Javascript-Projects.git
20+
```
21+
22+
- Navigate to the cloned repository:
23+
```bash
24+
cd All-In-One-Javascript-Projects
25+
```
26+
- Create a new branch for your changes:
27+
```bash
28+
git checkout -b feature/your-feature-name
29+
```
30+
### 5. Add Your Scripts
31+
- Add your JavaScript files to the appropriate folder and make sure to test your scripts thoroughly.
32+
33+
### 6. Commit Your Changes
34+
- Commit your changes with a descriptive message:
35+
```bash
36+
git add .
37+
git commit -m "Add [feature] or [fix] description"
38+
```
39+
### 7. Push to Your Fork
40+
- Push your changes to your forked repository:
41+
```bash
42+
git push origin feature/your-feature-name
43+
```
44+
### 8. Create a Pull Request
45+
- Go to the original repository and click on the "New Pull Request" button.
46+
- Compare your branch with the base branch of the original repository.
47+
- Provide a clear description of the changes you made and reference the issue number if applicable (e.g., Fixes `#issue-number`).
48+
- Submit your pull request and wait for review.
49+
50+
## Code of Conduct
51+
Please adhere to the [Code of Conduct](CODE_OF_CONDUCT.md) when contributing to this repository.
52+
53+
## Additional Notes
54+
- Avoid making large changes in one commit; it's better to make several small commits.
55+
- Ensure your code follows the existing coding style and conventions in the repository.
56+
- Be respectful and open to feedback during the review process.
57+
58+
Thank you for contributing! We appreciate your help in making All-In-One-Javascript-Projects better for everyone!

‎Example README.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Script Name
2+
**Short description of package/script**
3+
A brief overview of what this script or package does.
4+
5+
### Functionalities
6+
- **Functionality 1**: Brief description of what it does.
7+
- **Functionality 2**: Brief description of what it does.
8+
- **Functionality 3**: Brief description of what it does.
9+
10+
## Description
11+
Provide a detailed explanation of your script, its purpose, and any important details that aren't easily understood through comments in the code. This section can also include edge cases, limitations, or assumptions made while developing the script.
12+
13+
## Prerequisites
14+
List out the libraries or packages imported in the script. For example:
15+
- `library1`: Description of the library and its purpose.
16+
- `library2`: Description of the library and its purpose.
17+
- `library3`: Description of the library and its purpose.
18+
19+
## Installing Instructions
20+
Explain how to set up and run your package/script on the user's local machine. Include steps like:
21+
1. Clone the repository:
22+
```bash
23+
git clone https://github.com/your-username/All-In-One-Javascript-Projects.git
24+
```
25+
2. Navigate to the project directory:
26+
```bash
27+
cd All-In-One-Javascript-Projects/<Project_Name>
28+
```
29+
3. Install the required libraries:
30+
```bash
31+
npm install
32+
```
33+
34+
4. Run the script:
35+
```bash
36+
node <script_name>.js
37+
```
38+
39+
## Screenshot
40+
Provide images, GIFs, or videos of the output/result of your script. This will help users visualize the functionality of your project.
41+
42+
## Author
43+
Name(s) of author(s)
44+
- Your Name
45+
- Collaborator Name
46+
47+
### Notes for Contributors:
48+
- Ensure to fill out each section thoroughly for clarity.
49+
- Use clear and concise language to help users understand the functionality of your script.
50+
- If applicable, include examples of usage in the description.
51+
- Keep the formatting consistent for a professional appearance.

‎README.md

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
<h1 align="center"> All-In-One-Javascript-Projects </h1>
2+
3+
<!-- banner -->
4+
![All-In-One-Javascript-Projects](https://socialify.git.ci/king04aman/All-In-One-Javascript-Projects/image?description=1&font=Jost&language=1&logo=https%3A%2F%2Fimages.weserv.nl%2F%3Furl%3Dhttps%3A%2F%2Favatars.githubusercontent.com%2Fu%2F62813940%3Fv%3D4%26h%3D250%26w%3D250%26fit%3Dcover%26mask%3Dcircle%26maxage%3D7d&name=1&owner=1&pattern=Floating%20Cogs&theme=Dark)
5+
6+
<!-- project badges -->
7+
[![BuiltByDev](https://forthebadge.com/images/badges/built-by-developers.svg)](https://github.com/king04aman)
8+
[![BuiltWithLov](https://forthebadge.com/images/badges/built-with-love.svg)](https://github.com/king04aman)
9+
[![MadeWithJS](https://forthebadge.com/images/badges/made-with-javascript.svg)](https://github.com/king04aman)
10+
<br/>
11+
![Issues](https://img.shields.io/github/issues/king04aman/All-In-One-Javascript-Projects.svg)
12+
![Contributors](https://img.shields.io/github/contributors/king04aman/All-In-One-Javascript-Projects.svg)
13+
![SizeInBytes](https://img.shields.io/github/repo-size/king04aman/All-In-One-Javascript-Projects.svg)
14+
![TopLanguage](https://img.shields.io/github/languages/top/king04aman/All-In-One-Javascript-Projects.svg)
15+
![LinesOfCode](https://img.shields.io/tokei/lines/github/king04aman/All-In-One-Javascript-Projects?color=red&label=Lines%20of%20Code)
16+
![PullRequests](https://img.shields.io/github/issues-pr/king04aman/All-In-One-Javascript-Projects.svg)
17+
18+
19+
<h2 align="center"> Description </h2>
20+
21+
_All-In-One-Javascript-Projects is a collection of all scripts starting from very basic to advance scripts. This is your personal zone where you may search or add any new scripts that can simplify your or other developer's life and give them something to do when they're bored. Start producing exciting scripts that benefit the community._
22+
23+
<hr>
24+
25+
## Getting Started
26+
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
27+
28+
## Prerequisites
29+
- Node.js (preferably latest version)
30+
31+
## Installing
32+
1. Clone the repository to your local machine
33+
```bash
34+
git clone https://github.com/king04aman/All-In-One-Javascript-Projects.git
35+
```
36+
2. Change directory into the cloned repository
37+
```bash
38+
cd All-In-One-Javascript-Projects/<Project_name>
39+
```
40+
3. Install the required libraries
41+
```bash
42+
npm install
43+
```
44+
4. Run the program using
45+
```bash
46+
node <script_name>.js
47+
```
48+
49+
50+
<hr>
51+
52+
<h2 align='center'> Contribution Guide</h2>
53+
54+
- Have a look at [Contributing Guidelines](CONTRIBUTING.md).
55+
- Take a look at the existing issues or create your own issues.
56+
- Avoid making pull request unless you are assigned with the issue.
57+
- Select the project on which you want to work or you can add your own project.
58+
- Create an issue with description on which project you want to work and wait for approval.
59+
- While making pull request add issue number with `#` (for example `#04`)
60+
- After approval fork this repository, add your changes then make pull request with issue number and wait for review.
61+
- Star this repository.
62+
63+
64+
<h2 align=center> Awesome Contributors </h2>
65+
66+
Thanks go to these **Wonderful Contributors**:
67+
68+
69+
<table>
70+
<tr>
71+
<td>
72+
<a href="https://github.com/king04aman/All-In-One-Javascript-Projects/graphs/contributors">
73+
<img src="https://contrib.rocks/image?repo=king04aman/All-In-One-Javascript-Projects" />
74+
</a>
75+
</td>
76+
</tr>
77+
</table>
78+
79+
<hr>
80+
81+
<h2 align='center'>Project Maintainer </h2>
82+
83+
<table>
84+
<tr>
85+
<td align="center">
86+
<a href="https://github.com/king04aman">
87+
<img src="https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/62813940?v=4&h=250&w=250&fit=cover&mask=circle&maxage=7d" width=100px height=100px />
88+
</a></br>
89+
<h4 style="color:#ff8c00;font-weight: bolder; font-size: 15px">Aman Kumar</h4>
90+
</td>
91+
</tr>
92+
</table>
93+
94+
## License
95+
*This project is licensed under the MIT License - see the [LICENSE.md](LICENSE) file for details.*
96+
97+
<hr>
98+
<h3 align='center'>🎉 😃 Happy Coding 😃 🎉 </h3>

‎SECURITY.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Security Policy
2+
3+
## Reporting a Vulnerability
4+
5+
If you discover a security vulnerability within this project, please follow these steps:
6+
7+
1. **Do Not Create a Public Issue**: To protect the integrity of the project and its users, please do not disclose the vulnerability publicly in GitHub issues.
8+
9+
2. **Contact the Maintainer**: Send an email to [comingSoon@email.com] with the following details:
10+
- A description of the vulnerability
11+
- Steps to reproduce it
12+
- The impact of the vulnerability
13+
- Any other relevant information
14+
15+
3. **Wait for a Response**: The project maintainers will respond as soon as possible to discuss the issue and coordinate a resolution. We aim to address all reported vulnerabilities promptly and responsibly.
16+
17+
## Security Improvements
18+
19+
We welcome contributions aimed at improving the security of this project. If you have suggestions or ideas for enhancing security, please reach out via the same email.
20+
21+
## Disclaimer
22+
23+
While we strive to maintain the security of this project, we cannot guarantee that it is free from all vulnerabilities. Users should take appropriate precautions when using this software, especially in production environments.
24+
25+
## Security Best Practices
26+
27+
We encourage contributors to adhere to security best practices, including:
28+
- Validating and sanitizing user input
29+
- Keeping dependencies up to date
30+
- Following secure coding guidelines
31+
32+
Thank you for helping us keep the project secure!

0 commit comments

Comments
 (0)