Skip to content

Commit 1a3f624

Browse files
sanjay-kvsanjay-kv
authored
Merge pull request #171 from Nikhil0-3/main
Adding contributing.md file (Also added code_of_conduct.md file)
2 parents b6f2286 + a8fda01 commit 1a3f624

File tree

2 files changed

+254
-0
lines changed

2 files changed

+254
-0
lines changed

‎code_of_conduct.md‎

Lines changed: 145 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,145 @@
1+
# ✨Contributor Covenant Code of Conduct✨
2+
3+
---
4+
5+
## 🌟Our Pledge
6+
---
7+
We as members, contributors, and leaders pledge to make participation in our
8+
community a harassment-free experience for everyone, regardless of age, body
9+
size, visible or invisible disability, ethnicity, sex characteristics, gender
10+
identity and expression, level of experience, education, socio-economic status,
11+
nationality, personal appearance, race, religion, or sexual identity
12+
and orientation.
13+
14+
We pledge to act and interact in ways that contribute to an open, welcoming,
15+
diverse, inclusive, and healthy community.
16+
17+
---
18+
## 🚦Our Standards
19+
20+
Examples of behavior that contributes to a positive environment for our
21+
community include:
22+
23+
* 💖Demonstrating empathy and kindness toward other people
24+
* 🤝Being respectful of differing opinions, viewpoints, and experiences
25+
* 📝Giving and gracefully accepting constructive feedback
26+
* 🌱Accepting responsibility and apologizing to those affected by our mistakes,
27+
and learning from the experience
28+
* 🎯Focusing on what is best not just for us as individuals, but for the
29+
overall community
30+
31+
Examples of unacceptable behavior include:
32+
33+
* 🚫The use of sexualized language or imagery, and sexual attention or
34+
advances of any kind
35+
* 🛑Trolling, insulting or derogatory comments, and personal or political attacks
36+
* ⚠️Public or private harassment
37+
* 🔒Publishing others' private information, such as a physical or email
38+
address, without their explicit permission
39+
* ❌Other conduct which could reasonably be considered inappropriate in a
40+
professional setting
41+
42+
---
43+
44+
## 👨‍⚖️Enforcement Responsibilities
45+
46+
Community leaders are responsible for clarifying and enforcing our standards of
47+
acceptable behavior and will take appropriate and fair corrective action in
48+
response to any behavior that they deem inappropriate, threatening, offensive,
49+
or harmful.
50+
51+
Community leaders have the right and responsibility to remove, edit, or reject
52+
comments, commits, code, wiki edits, issues, and other contributions that are
53+
not aligned to this Code of Conduct, and will communicate reasons for moderation
54+
decisions when appropriate.
55+
56+
---
57+
## 🌐Scope
58+
59+
This Code of Conduct applies within all community spaces, and also applies when
60+
an individual is officially representing the community in public spaces.
61+
Examples of representing our community include using an official e-mail address,
62+
posting via an official social media account, or acting as an appointed
63+
representative at an online or offline event.
64+
65+
---
66+
## 📋Pull Request Guidelines
67+
68+
Contributions, including pull requests, must align with this Code of Conduct.
69+
All contributors are expected to submit work that fosters a positive and inclusive community.
70+
Inappropriate behavior, language, or content in pull requests may result in the rejection of
71+
the contribution and further enforcement actions as outlined in the guidelines.
72+
73+
---
74+
## 🛡️Enforcement
75+
76+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
77+
reported to the community leaders responsible for enforcement at
78+
.
79+
All complaints will be reviewed and investigated promptly and fairly.
80+
81+
All community leaders are obligated to respect the privacy and security of the
82+
reporter of any incident.
83+
84+
---
85+
## 📖Enforcement Guidelines
86+
87+
Community leaders will follow these Community Impact Guidelines in determining
88+
the consequences for any action they deem in violation of this Code of Conduct:
89+
90+
### 1. ✏️Correction
91+
92+
**Community Impact**: Use of inappropriate language or other behavior deemed
93+
unprofessional or unwelcome in the community.
94+
95+
**Consequence**: A private, written warning from community leaders, providing
96+
clarity around the nature of the violation and an explanation of why the
97+
behavior was inappropriate. A public apology may be requested.
98+
99+
### 2. ⚠️Warning
100+
101+
**Community Impact**: A violation through a single incident or series
102+
of actions.
103+
104+
**Consequence**: A warning with consequences for continued behavior. No
105+
interaction with the people involved, including unsolicited interaction with
106+
those enforcing the Code of Conduct, for a specified period of time. This
107+
includes avoiding interactions in community spaces as well as external channels
108+
like social media. Violating these terms may lead to a temporary or
109+
permanent ban.
110+
111+
### 3. ⏳Temporary Ban
112+
113+
**Community Impact**: A serious violation of community standards, including
114+
sustained inappropriate behavior.
115+
116+
**Consequence**: A temporary ban from any sort of interaction or public
117+
communication with the community for a specified period of time. No public or
118+
private interaction with the people involved, including unsolicited interaction
119+
with those enforcing the Code of Conduct, is allowed during this period.
120+
Violating these terms may lead to a permanent ban.
121+
122+
### 4. 🚫Permanent Ban
123+
124+
**Community Impact**: Demonstrating a pattern of violation of community
125+
standards, including sustained inappropriate behavior, harassment of an
126+
individual, or aggression toward or disparagement of classes of individuals.
127+
128+
**Consequence**: A permanent ban from any sort of public interaction within
129+
the community.
130+
131+
---
132+
## 📜Attribution
133+
134+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
135+
version 2.0, available at
136+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
137+
138+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
139+
enforcement ladder](https://github.com/mozilla/diversity).
140+
141+
[homepage]: https://www.contributor-covenant.org
142+
143+
For answers to common questions about this code of conduct, see the FAQ at
144+
https://www.contributor-covenant.org/faq. Translations are available at
145+
https://www.contributor-covenant.org/translations.

‎contributing.md‎

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
# 🌟 Thank you for your interest in contributing to Opensource-practice!🌟
2+
This project is designed to help developers practice and enhance their open-source contribution skills. Whether you're here to report a bug, suggest a feature, or help develop new functionalities, your contribution is highly appreciated. 🚀
3+
4+
# 📊 Project Overview
5+
Opensource-practice is a platform that allows developers to practice open-source contributions in a collaborative environment. The project aims to provide opportunities for contributors to improve their coding skills, learn how to use Git and GitHub effectively, and work in a team-driven setting.
6+
7+
- ⭐ Stars: [stars count]
8+
- 🍴 Forks: [forks count]
9+
- 🐛 Issues: [issues count]
10+
- 🔔 Open Pull Requests: [open PRs count]
11+
- 🔕 Closed Pull Requests: [closed PRs count]
12+
- 🛠️ Languages Used: [languages count]
13+
- 🌐 Contributors: [contributors count]
14+
15+
# 🛠️ Getting Started
16+
To begin contributing, follow these simple steps:
17+
18+
- **Fork this Repository 🍴:** Fork the repository to your own GitHub account by clicking the Fork button on the repository page.
19+
20+
- **Clone the Repository 🧩:** Once forked, clone the repository to your local machine:
21+
```bash
22+
23+
git clone https://github.com/Your-Username/Opensource-practice.git
24+
```
25+
- **Create a New Branch 🌿:** It's important to work on a separate branch for your feature or fix:
26+
27+
```bash
28+
git checkout -b "Feature-Name"
29+
```
30+
- **Make Your Changes 🛠️:** Implement your changes or fixes and ensure they work as expected.
31+
32+
- **Commit Your Changes 💬:** Commit your changes with a meaningful commit message:
33+
34+
```bash
35+
git commit -m "Brief Description of Changes"
36+
```
37+
- **Push Your Changes 🚢:** Push your branch to your GitHub repository:
38+
39+
```bash
40+
git push origin Feature-Name
41+
```
42+
- **Submit a Pull Request 🔥:** Open a pull request (PR) on GitHub for your changes to be reviewed.
43+
44+
# 🎉 Welcome, Contributors
45+
We encourage contributors from all backgrounds and skill levels! Whether you're fixing bugs 🐛, adding new features 🆕, or improving documentation 📄, your help is invaluable.
46+
47+
Here’s a quick guide to contribute:
48+
49+
- Fork the Repository: Start by forking the project repository.
50+
- Create a Feature Branch: Work on a separate branch for your contributions.
51+
- Write Clear Commit Messages: Ensure your commits are descriptive and meaningful.
52+
- Push Your Changes: Push your changes to GitHub.
53+
- Open a Pull Request: Submit your PR and wait for feedback from the maintainers.
54+
55+
# 📜 Contribution Guidelines
56+
Please follow these guidelines to maintain high-quality contributions:
57+
58+
1.**Code Style:**
59+
Ensure consistent code formatting according to the existing style. Write clean, readable, and well-documented code.
60+
61+
2.**Commit Messages:**
62+
Make your commit messages clear and concise, reflecting the changes you made.
63+
64+
3.**Pull Requests:**
65+
Each PR should focus on a single issue or feature. Link relevant issues to your PR.
66+
67+
4.**Testing:**
68+
Test your changes thoroughly before opening a pull request. Make sure no existing functionality breaks.
69+
70+
5.**Issue Tracker:**
71+
Review open issues before starting work on a feature or fix. Reference related issues in your PR.
72+
73+
# 💻 Technologies Used
74+
75+
Opensource-practice is built using a combination of modern tools to provide a seamless development experience:
76+
77+
- Frontend: HTML, CSS, JavaScript 🌐
78+
- Backend: Node.js 🟩, Express.js 🚀
79+
- Version Control: Git & GitHub 🛠️
80+
81+
# 🔄 How to Submit a Pull Request
82+
To submit a pull request:
83+
84+
- Fork and clone the repository locally.
85+
- Follow the setup instructions in the README to run the project locally.
86+
- Make your desired changes.
87+
- Test your changes locally to ensure everything works.
88+
- Commit the changes following the commit message format guidelines.
89+
- Open a pull request and wait for a review.
90+
91+
# 🐞 Reporting Issues
92+
If you find any bugs or have feature suggestions, here’s how you can report them:
93+
94+
Check for Existing Issues: Before opening a new issue, review the existing issue tracker.
95+
Open a New Issue: If your issue is new, click the "New Issue" button and provide detailed information.
96+
Be Specific: Include steps to reproduce the issue and describe the expected vs actual behavior.
97+
Provide Logs/Screenshots: Include relevant screenshots or logs for a quicker resolution.
98+
99+
# 🌐 Community & Communication
100+
For any questions or discussions, feel free to use GitHub Discussions or Issues. We're here to collaborate, share ideas, and improve together.
101+
102+
# 📂 Project Structure
103+
Opensource-practice follows a well-organized structure to promote collaboration and maintainability. If you make any structural changes, make sure to document them accordingly.
104+
105+
# 💡 Need Ideas?
106+
Check out the Issues tab for open tasks or feel free to suggest new features that align with our goals!
107+
108+
# ✨ Join Us!
109+
We’re excited to have you on board! Star ⭐ the project if you like it, and help us build an amazing open-source platform. Your contributions are making an impact! 🌟

0 commit comments

Comments
 (0)