Skip to content

Commit ae3d2c2

Browse files
king04amanking04aman
committed
docs: Added detailed documentation and guidelines into the project
1 parent 280ec0c commit ae3d2c2

File tree

5 files changed

+198
-0
lines changed

5 files changed

+198
-0
lines changed

‎CODE_OF_CONDUCT.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Code of Conduct
2+
*As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.*
3+
4+
*We are committed to creating a welcoming and inclusive environment for all people, regardless of their background or identity. We expect all members of our community, including contributors, users, and maintainers, to abide by this Code of Conduct.*
5+
6+
## Our Standards
7+
- Examples of behavior that contributes to creating a positive environment include:
8+
- Be respectful of others and their opinions
9+
- Refrain from using discriminatory language or behavior
10+
- Avoid engaging in personal attacks or harassment
11+
- Help create a safe and positive environment for everyone
12+
- Follow the project's guidelines and procedures
13+
14+
- Examples of unacceptable behavior by participants include:
15+
- Harassment or discrimination of any kind
16+
- Threats, bullying, or violence
17+
- Sharing of private information without consent
18+
- Plagiarism or infringement of intellectual property rights
19+
- Any other behavior that is deemed unacceptable by the project maintainers
20+
21+
## Our Responsibilities
22+
- 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.
23+
- 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, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
24+
25+
## Consequences
26+
- If you engage in behavior that violates this Code of Conduct, you may be asked to stop, or other appropriate action may be taken.
27+
- If any unacceptable behavior will be determined by the project maintainers, and may include:
28+
- Warning
29+
- Removal from the project or community
30+
- Reporting to appropriate authorities
31+
32+
## Reporting
33+
- If you witness or experience conduct that violates this Code of Conduct, please contact us immediately on [Linkedin](https://linkedin.com/in/king04aman/). We will take all reports seriously and will work to resolve the issue as quickly as possible.
34+
35+
## Attribution
36+
- This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at [https://www.contributor-covenant.org/version/1/4/code-of-conduct.html](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html)

‎CONTRIBUTING.md‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Contributing Guidelines
2+
*Thank you for your interest in contributing to this Python project! We welcome and appreciate contributions of all kinds, from bug reports and feature requests to documentation and code improvements.*
3+
4+
## How to Contribute
5+
*Here are some ways you can contribute:*
6+
- [Report an issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/creating-an-issue)
7+
- [Suggest a feature](CONTRIBUTING.md)
8+
- Improve the documentation
9+
- [Contribute code](CODE_OF_CONDUCT.md)
10+
11+
## Reporting Issues
12+
*When reporting an issue, please include the following:*
13+
- A clear and descriptive title
14+
- A detailed description of the issue, including steps to reproduce the problem
15+
- Screenshots or other relevant media
16+
- The version of the project and dependencies you are using
17+
- The operating system and version you are using
18+
19+
## Suggest a feature
20+
*To suggest a new feature, please open an issue on GitHub and provide a detailed description of what you would like to see added, and why it would be useful.*
21+
22+
## Improve the documentation
23+
*We welcome improvements to the documentation, whether they're typo fixes, explanations of complex concepts, or examples of how to use the software. To make changes to the documentation, please fork the repository, make your changes, and submit a pull request.*
24+
25+
## Contribute code Guidelines
26+
*If you're interested in contributing code to the project, please follow these guidelines:*
27+
28+
- Fork the repository. This creates a copy of the code that you can work on without affecting the original project.
29+
- Create a new branch. Use a descriptive name that reflects the changes you plan to make.
30+
- Make your changes. Keep your code clean, well-organized, and easy to read. Follow the project's existing coding style as closely as possible.
31+
- Test your changes. Make sure your changes don't break existing functionality and that they work as expected.
32+
- Submit a pull request. Once you've made your changes and tested them, submit a pull request. Please provide a clear and concise description of your changes and why they're needed.
33+
- Add documentation. Add documentation to the README.md file and to the code files.
34+
35+
## Pull Request Guidelines
36+
- Fork the repository and create a new branch for your changes.
37+
- Follow the existing code style and conventions.
38+
- Include tests for any new code.
39+
- Make sure all tests pass before submitting the pull request.
40+
- Do not include changes to the README or other documentation in the same pull request as code changes.
41+
42+
## Code of Conduct
43+
*Please note that this project is released with a Code of Conduct. By participating in this project you agree to abide by its terms.*
44+
45+
## License
46+
This project is licensed under the terms of the MIT license.
47+
48+
## Thank you!
49+
Thank you for your interest in contributing to this project! We appreciate your help and look forward to working with you.

‎Example README.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Script Name
2+
Short description of package/script
3+
- If package, list of functionalities/scripts it can perform
4+
- If standalone script, short description of script explaining what it achieves
5+
6+
# Description
7+
- If code is not explainable using comments, use this sections to explain your script
8+
9+
# Prerequisites
10+
- List out the libraries imported in the script
11+
12+
# Installing instructions
13+
- Explain how to setup and run your package/script in user's local machine.
14+
15+
# Screenshot
16+
- Display images/gifs/videos of output/result of your script so that users can visualize it.
17+
18+
# Author
19+
Name(s) of author(s).

‎LICENSE‎

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

‎README.md‎

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
<h1 align="center"> All-In-One-Python-Projects </h1>
2+
3+
<!-- project badges -->
4+
[![forthebadge](https://forthebadge.com/images/badges/built-by-developers.svg)](https://forthebadge.com)
5+
[![forthebadge](https://forthebadge.com/images/badges/built-with-love.svg)](https://forthebadge.com)
6+
[![forthebadge](https://forthebadge.com/images/badges/made-with-python.svg)](https://forthebadge.com)
7+
8+
![GitHub issues](https://img.shields.io/github/issues/king04aman/keylogger.svg)
9+
![GitHub contributors](https://img.shields.io/github/contributors/king04aman/hacktoberfest2022.svg)
10+
![GitHub repo size in bytes](https://img.shields.io/github/repo-size/kevinelong/All-In-One-Python-Projects.svg)
11+
![GitHub top language](https://img.shields.io/github/languages/top/king04aman/hacktoberfest2022.svg)
12+
![Lines of Code](https://img.shields.io/tokei/lines/github/king04aman/hacktoberfest2022?color=red&label=Lines%20of%20Code)
13+
[![GitHub pull requests](https://img.shields.io/github/issues-pr/avinashkranjan/Amazing-Python-Scripts.svg)](https://github.com/avinashkranjan/Amazing-Python-Scripts/pulls)
14+
15+
<h2 align="center"> Description </h2>
16+
17+
_All-In-One-Python-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._
18+
19+
<hr>
20+
21+
## Getting Started
22+
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
23+
24+
## Prerequisites
25+
- Python 3.x
26+
27+
## Installing
28+
1. Clone the repository to your local machine
29+
```bash
30+
git clone https://github.com/king04aman/All-In-One-Python-Projects.git
31+
```
32+
2. Change directory into the cloned repository
33+
```bash
34+
cd All-In-One-Python-Projects/<Project_name>
35+
```
36+
3. Install the required libraries
37+
```bash
38+
pip install -r requirements.txt
39+
```
40+
4. Run the program using
41+
```bash
42+
python3 <script_name>.py
43+
```
44+
45+
<hr>
46+
47+
<h2 align=center> Contributing </h2>
48+
49+
- Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our [code of conduct](CODE_OF_CONDUCT.md), and the process for submitting pull requests to us.
50+
51+
<h2 align=center> Awesome Contributors 🤩 </h2>
52+
53+
Thanks go to these **Wonderful Contributors** ✨✨:
54+
55+
<table>
56+
<tr>
57+
<td>
58+
<a href="https://github.com/king04aman/hacktoberfest2022/graphs/contributors">
59+
<img src="https://contrib.rocks/image?repo=king04aman/hacktoberfest2022" />
60+
</a>
61+
</td>
62+
</tr>
63+
</table>
64+
65+
<hr>
66+
67+
<h2 align='center'>Project Maintainer </h2>
68+
69+
<table>
70+
<tr>
71+
<td align="center">
72+
<a href="https://github.com/avinashkranjan">
73+
<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 />
74+
</a></br>
75+
<h4 style="color:#ff8c00;font-weight: bolder; font-size: 15px">Aman Kumar</h4>
76+
</td>
77+
</tr>
78+
</table>
79+
80+
## License
81+
*This project is licensed under the MIT License - see the [LICENSE.md](LICENSE) file for details.*
82+
83+
84+
<hr>
85+
<h3 align='center'>🎉 😃 Happy Hacking 😃 🎉 </h3>

0 commit comments

Comments
 (0)