Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 70 additions & 0 deletions docs/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
# 📜 **CODE OF CONDUCT**

## 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 contribute to a positive environment include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Taking responsibility for our mistakes and learning from them
* Focusing on what is best for the community

#### Examples of unacceptable behavior include:

* Harassment, trolling, insulting or derogatory comments
* Personal or political attacks
* Public or private harassment
* Publishing others' private information without permission
* Other conduct which could reasonably be considered inappropriate

---

### Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action.

---

### Scope

This Code applies within all community spaces and also applies when an individual is representing the project or its community publicly.

---

### Enforcement Guidelines

#### 1. Correction

Community leaders may issue a private, written warning when inappropriate behavior occurs.

#### 2. Warning

A formal warning may be issued with consequences for continued behavior.

#### 3. Temporary Ban

A temporary ban may be enforced for repeated or severe violations.

#### 4. Permanent Ban

A permanent ban may be issued for long-term harmful behavior or severe violations.

---

### Attribution

This Code of Conduct is adapted from the **Contributor Covenant**, version 2.1.
For more information, visit: [https://www.contributor-covenant.org/version/2/1/code_of_conduct/](https://www.contributor-covenant.org/version/2/1/code_of_conduct/)

---
30 changes: 30 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,38 @@
![GitHub issues](https://img.shields.io/github/issues/Tanyasharma71/peacebot-ai?style=for-the-badge)
![License](https://img.shields.io/github/license/Tanyasharma71/peacebot-ai?style=for-the-badge)


# 📑 **Table of Contents**

* [🧘‍♀️ Introduction](#🧘‍♀️-introduction)
* [💡 Key Features](#💡-key-features)
* [🧰 Tech Stack](#🧰-tech-stack)
* [🗂️ Project Structure](#🗂️-project-structure)
* [🚀 Quickstart](#🚀-quickstart)

* [1️⃣ Create and activate a virtual environment](#1️⃣-create-and-activate-a-virtual-environment)
* [2️⃣ Install dependencies](#2️⃣-install-dependencies)
* [3️⃣ Configure your API key](#3️⃣-configure-your-api-key)
* [4️⃣ Run the App](#4️⃣-run-the-app)
* [5️⃣ API Usage](#5️⃣-api-usage)
* [🧩 Configuration (peacebot.ini)](#🧩-configuration-peacebotini)
* [🔄 Logging Example](#🔄-logging-example)
* [🌱 Future Scope](#🌱-future-scope)
* [🤝 Contributing](#🤝-contributing)
* [📑 Contribution Guidelines](#📑-contribution-guidelines)
* [🧡 Contributing is Fun!](#🧡-contributing-is-fun)
* [👥 Contributors](#👥-contributors)
* [🧪 Running the Test Suite](#🧪-running-the-test-suite)

* [1️⃣ Run All Tests](#1️⃣-run-all-tests)
* [2️⃣ Run a Specific Test File](#2️⃣-run-a-specific-test-file)
* [3️⃣ Expected Output](#3️⃣-expected-output)
* [📄 License](#📄-license)
* [💬 A Final Note](#💬-a-final-note)

---


## 🧘‍♀️ Introduction

**Peacebot-AI** is an **AI-powered mental health chatbot** designed to provide **empathetic conversations**, **stress management tips**, and **mindfulness guidance** to users seeking emotional support.
Expand Down