From d5fc5d29c9c3bbf8ea74041c2e8d081de853b446 Mon Sep 17 00:00:00 2001 From: Durdana Sultana Date: Thu, 11 Dec 2025 07:48:08 +0530 Subject: [PATCH 1/2] Added toc in readme --- docs/README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/docs/README.md b/docs/README.md index 20f61ea..95b594f 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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. From b73c720a03fbe3abcba6949e6ea4be818ac58cfb Mon Sep 17 00:00:00 2001 From: Durdana Sultana Date: Thu, 11 Dec 2025 07:50:57 +0530 Subject: [PATCH 2/2] Added code of conduct file --- docs/CODE_OF_CONDUCT.md | 70 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 70 insertions(+) create mode 100644 docs/CODE_OF_CONDUCT.md diff --git a/docs/CODE_OF_CONDUCT.md b/docs/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..55f7635 --- /dev/null +++ b/docs/CODE_OF_CONDUCT.md @@ -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/) + +---