From 03e4f47bf60f42d66d67d1fcd9736e78f3f2396f Mon Sep 17 00:00:00 2001 From: Nikhil More <149102391+Nikhil0-3@users.noreply.github.com> Date: Mon, 21 Oct 2024 09:35:55 +0530 Subject: [PATCH 1/2] Create code_of_conduct.md --- code_of_conduct.md | 145 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 145 insertions(+) create mode 100644 code_of_conduct.md diff --git a/code_of_conduct.md b/code_of_conduct.md new file mode 100644 index 0000000..7cf49ac --- /dev/null +++ b/code_of_conduct.md @@ -0,0 +1,145 @@ +# ✨Contributor Covenant Code of Conduct✨ + +--- + +## 🌟Our Pledge +--- +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, religion, or sexual identity +and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +--- +## 🚦Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* 💖Demonstrating empathy and kindness toward other people +* 🤝Being respectful of differing opinions, viewpoints, and experiences +* 📝Giving and gracefully accepting constructive feedback +* 🌱Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* 🎯Focusing on what is best not just for us as individuals, but for the + overall community + +Examples of unacceptable behavior include: + +* 🚫The use of sexualized language or imagery, and sexual attention or + advances of any kind +* 🛑Trolling, insulting or derogatory comments, and personal or political attacks +* ⚠️Public or private harassment +* 🔒Publishing others' private information, such as a physical or email + address, without their explicit permission +* ❌Other conduct which could reasonably be considered inappropriate in a + professional setting + +--- + +## 👨‍⚖️Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders 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. + +--- +## 🌐Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +--- +## 📋Pull Request Guidelines + +Contributions, including pull requests, must align with this Code of Conduct. +All contributors are expected to submit work that fosters a positive and inclusive community. +Inappropriate behavior, language, or content in pull requests may result in the rejection of +the contribution and further enforcement actions as outlined in the guidelines. + +--- +## 🛡️Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +--- +## 📖Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. ✏️Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. ⚠️Warning + +**Community Impact**: A violation through a single incident or series +of actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or +permanent ban. + +### 3. ⏳Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. 🚫Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within +the community. + +--- +## 📜Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.0, available at +https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. + +Community Impact Guidelines were inspired by [Mozilla's code of conduct +enforcement ladder](https://github.com/mozilla/diversity). + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see the FAQ at +https://www.contributor-covenant.org/faq. Translations are available at +https://www.contributor-covenant.org/translations. From a8fda017d48e333c6a2a053f451a79a0a89fb428 Mon Sep 17 00:00:00 2001 From: Nikhil More <149102391+Nikhil0-3@users.noreply.github.com> Date: Mon, 21 Oct 2024 09:53:38 +0530 Subject: [PATCH 2/2] Create contributing.md --- contributing.md | 109 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 109 insertions(+) create mode 100644 contributing.md diff --git a/contributing.md b/contributing.md new file mode 100644 index 0000000..3bfd82c --- /dev/null +++ b/contributing.md @@ -0,0 +1,109 @@ +# 🌟 Thank you for your interest in contributing to Opensource-practice!🌟 +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. 🚀 + +# 📊 Project Overview +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. + +- ⭐ Stars: [stars count] +- 🍴 Forks: [forks count] +- 🐛 Issues: [issues count] +- 🔔 Open Pull Requests: [open PRs count] +- 🔕 Closed Pull Requests: [closed PRs count] +- 🛠️ Languages Used: [languages count] +- 🌐 Contributors: [contributors count] + +# 🛠️ Getting Started +To begin contributing, follow these simple steps: + +- **Fork this Repository 🍴:** Fork the repository to your own GitHub account by clicking the Fork button on the repository page. + +- **Clone the Repository 🧩:** Once forked, clone the repository to your local machine: +```bash + +git clone https://github.com/Your-Username/Opensource-practice.git +``` +- **Create a New Branch 🌿:** It's important to work on a separate branch for your feature or fix: + +```bash +git checkout -b "Feature-Name" +``` +- **Make Your Changes 🛠️:** Implement your changes or fixes and ensure they work as expected. + +- **Commit Your Changes 💬:** Commit your changes with a meaningful commit message: + +```bash +git commit -m "Brief Description of Changes" +``` +- **Push Your Changes 🚢:** Push your branch to your GitHub repository: + +```bash +git push origin Feature-Name +``` +- **Submit a Pull Request 🔥:** Open a pull request (PR) on GitHub for your changes to be reviewed. + +# 🎉 Welcome, Contributors +We encourage contributors from all backgrounds and skill levels! Whether you're fixing bugs 🐛, adding new features 🆕, or improving documentation 📄, your help is invaluable. + +Here’s a quick guide to contribute: + +- Fork the Repository: Start by forking the project repository. +- Create a Feature Branch: Work on a separate branch for your contributions. +- Write Clear Commit Messages: Ensure your commits are descriptive and meaningful. +- Push Your Changes: Push your changes to GitHub. +- Open a Pull Request: Submit your PR and wait for feedback from the maintainers. + +# 📜 Contribution Guidelines +Please follow these guidelines to maintain high-quality contributions: + +1.**Code Style:** +Ensure consistent code formatting according to the existing style. Write clean, readable, and well-documented code. + +2.**Commit Messages:** +Make your commit messages clear and concise, reflecting the changes you made. + +3.**Pull Requests:** +Each PR should focus on a single issue or feature. Link relevant issues to your PR. + +4.**Testing:** +Test your changes thoroughly before opening a pull request. Make sure no existing functionality breaks. + +5.**Issue Tracker:** +Review open issues before starting work on a feature or fix. Reference related issues in your PR. + +# 💻 Technologies Used + +Opensource-practice is built using a combination of modern tools to provide a seamless development experience: + +- Frontend: HTML, CSS, JavaScript 🌐 +- Backend: Node.js 🟩, Express.js 🚀 +- Version Control: Git & GitHub 🛠️ + +# 🔄 How to Submit a Pull Request +To submit a pull request: + +- Fork and clone the repository locally. +- Follow the setup instructions in the README to run the project locally. +- Make your desired changes. +- Test your changes locally to ensure everything works. +- Commit the changes following the commit message format guidelines. +- Open a pull request and wait for a review. + +# 🐞 Reporting Issues +If you find any bugs or have feature suggestions, here’s how you can report them: + +Check for Existing Issues: Before opening a new issue, review the existing issue tracker. +Open a New Issue: If your issue is new, click the "New Issue" button and provide detailed information. +Be Specific: Include steps to reproduce the issue and describe the expected vs actual behavior. +Provide Logs/Screenshots: Include relevant screenshots or logs for a quicker resolution. + +# 🌐 Community & Communication +For any questions or discussions, feel free to use GitHub Discussions or Issues. We're here to collaborate, share ideas, and improve together. + +# 📂 Project Structure +Opensource-practice follows a well-organized structure to promote collaboration and maintainability. If you make any structural changes, make sure to document them accordingly. + +# 💡 Need Ideas? +Check out the Issues tab for open tasks or feel free to suggest new features that align with our goals! + +# ✨ Join Us! +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! 🌟