Skip to content

Commit 3c82079

Browse files
authored
update contribution guidelines (#7)
* Create CONTRIBUTING.md * Update README.md * Create Code_of_conduct.md * Update README.md * Update README.md
1 parent b2c268b commit 3c82079

File tree

3 files changed

+73
-0
lines changed

3 files changed

+73
-0
lines changed

CONTRIBUTING.md

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
<h1 align="center">✨ Contributors Guide ✨</h1>
2+
<h3 align="center">Welcome to GitHub-ReadME-Terminal project! 😍<br> We appreciate your interest in contributing.😊 <br>This guide will help you get started with the project and make your first contribution.</h3>
3+
4+
![Line](https://user-images.githubusercontent.com/85225156/171937799-8fc9e255-9889-4642-9c92-6df85fb86e82.gif)
5+
6+
## What you can Contribute?
7+
8+
**🐞Bug Fixing :**
9+
Contributors can help by reviewing and confirming reported issues. This includes verifying bugs, providing additional details, and prioritizing tasks for the development team.
10+
11+
**💡Feature Requests:**
12+
Contribute your innovative ideas to enhance our project's functionality by suggesting new features under this section!
13+
14+
**📝Documentation Updates:**
15+
Help us improve user experience and clarity by contributing to our documentation section with updates, clarifications, or additional information!
16+
17+
**✨Code Contributions :**
18+
Contributors can enhance the project by implementing new features or improvements suggested by users. This involves understanding requirements, designing solutions, and extending the functionality of this Github-Readme-terminal. 🚀
19+
20+
![Line](https://user-images.githubusercontent.com/85225156/171937799-8fc9e255-9889-4642-9c92-6df85fb86e82.gif)
21+
22+
## How to Contribute?
23+
- Drop a Star ⭐ in this repo
24+
- Take a look at the existing [Issues](https://github.com/x0rzavi/github-readme-terminal/issues).
25+
- Fork the Repo & create a branch for any issue that you are working on and commit your work.
26+
- At first raise an issue in which you want to work
27+
- Then after assigning only then work on that issue & make a PR
28+
- Create a [**Pull Request**](https://github.com/x0rzavi/github-readme-terminal/pulls), which will be promptly reviewed and given suggestions for improvements by the community.
29+
- **REMINDER: Don't raise more than 1 `Issue` at a time**
30+
- **IMPORTANT: Don't make any type of `Pull Request` until & unless you get assigned to an `Issue`**
31+
- Add screenshots or screen captures to your `Pull Request` to help us understand the effects of the changes that are included in your commits.
32+
33+
Thank you for your contribution!!
34+
35+
![Line](https://user-images.githubusercontent.com/85225156/171937799-8fc9e255-9889-4642-9c92-6df85fb86e82.gif)
36+
37+
<h2 align="center">Need more help? 🤔</h1>
38+
<p align="center">
39+
You can refer to the following articles on basics of Git and Github and also contact the Project Mentors, in case you are stuck: <br>
40+
<a href="https://help.github.com/en/desktop/contributing-to-projects/creating-an-issue-or-pull-request">How to create a Issue</a> <br>
41+
<a href="https://help.github.com/en/github/getting-started-with-github/fork-a-repo">Forking a Repo</a> <br>
42+
<a href="https://docs.github.com/en/get-started/quickstart/fork-a-repo#cloning-your-forked-repository">Cloning a Repo</a> <br>
43+
<a href="https://opensource.com/article/19/7/create-pull-request-github">How to create a Pull Request</a> <br>
44+
<a href="https://docs.github.com/get-started">Getting started with Git and GitHub</a> <br>
45+
</p>
46+
47+
<h2 align="center">Tip from us 😇</h1>
48+
<p align="center">It always takes time to understand and learn. So, don't worry at all. We know <b>you have got this</b>! 💪</p>
49+
<h3 align="center">Show some &nbsp;❤️&nbsp; by &nbsp;🌟&nbsp; this repository!</h3>

Code_of_conduct.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
## GitHub ReadME Terminal Code of Conduct
2+
3+
A Python project that empowers you to create visually stunning and unique GIFs for your GitHub Profile ReadME. Unleash your creativity and make your profile stand out from the rest!
4+
5+
- Respect and Inclusivity
6+
- No Code Deletion
7+
- Quality Over Quantity
8+
- Respect Others' Contributions
9+
- Collaborative Problem Solving
10+
- No Trolling or Disruptive Behavior
11+
- Attribution and Licensing
12+
- Privacy and Security
13+
- Reporting Violations **(NO spammy contribution will be allowed)**
14+
- Enforcement

README.md

+10
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,8 @@ A Python project that empowers you to create visually stunning and unique GIFs f
3939
- 🚨 Stand out in the developer community with **visually appealing** GIFs that can potentially make a lasting impression.
4040
- 📦 **High-level constructs** and functions for simulating various terminal operations provide unparalleled control over your ReadME aesthetic.
4141

42+
<p align="right"><a href="#top"><img src="https://img.shields.io/badge/Move%20to%20top-Blue?style=plastic" alt="Back To Top"></a></p>
43+
4244
## ⚙️ Prerequisites
4345

4446
1. Python >=3.9
@@ -180,10 +182,18 @@ Optional API keys for modules must be present in `.env` file or declared as envi
180182
- [ ] More in-built color schemes.
181183
- [ ] More in-built text animations.
182184

185+
<p align="right"><a href="#top"><img src="https://img.shields.io/badge/Move%20to%20top-Blue?style=plastic" alt="Back To Top"></a></p>
186+
183187
## 🌱 Contributing
184188

185189
This is an open source project licensed under MIT and we welcome contributions from the community. We appreciate all types of contributions, including bug reports, feature requests, documentation improvements, and code contributions.
186190

191+
Read our [Contributing Guidelines](https://github.com/x0rzavi/github-readme-terminal/blob/main/CONTRIBUTING.md) to learn about our development process, how to propose bugfixes and improvements of our Project
192+
193+
<h2>Code Of Conduct📑</h2>
194+
195+
This project and everyone participating in it is governed by the [Code of Conduct](https://github.com/x0rzavi/github-readme-terminal/blob/main/Code_of_conduct.md). By participating, you are expected to uphold this code.
196+
187197
## 🤝 Acknowledgments
188198

189199
- [liamg/liamg](https://github.com/liamg/liamg) - Inspiration.

0 commit comments

Comments
 (0)