From 11ade3ddcea05b6fae32de7d551bf5eebc245055 Mon Sep 17 00:00:00 2001 From: mdhaarishussain Date: Sun, 15 Feb 2026 14:13:21 +0530 Subject: [PATCH] chore: Add PR/issue templates, code of conduct, and update contributing guide - Add pull request template with checklist and type-of-change labels - Add bug report issue template with environment and API details - Add feature request issue template - Add Contributor Covenant Code of Conduct (v2.1) - Update CONTRIBUTING.md with code of conduct reference and correct repo URL Co-authored-by: SK Faizanuddin --- .github/ISSUE_TEMPLATE/bug_report.md | 46 ++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 27 +++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 38 +++++++++++++++ CODE_OF_CONDUCT.md | 57 +++++++++++++++++++++++ CONTRIBUTING.md | 8 +++- 5 files changed, 174 insertions(+), 2 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 CODE_OF_CONDUCT.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..28065d6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,46 @@ +--- +name: ๐Ÿ› Bug Report +about: Report a bug to help us improve ContextWeaver +title: "[Bug]: " +labels: bug +assignees: '' +--- + +## Describe the Bug + + + +## Steps to Reproduce + +1. Go to '...' +2. Click on '...' +3. Scroll down to '...' +4. See error + +## Expected Behavior + + + +## Actual Behavior + + + +## Screenshots + + + +## Environment + +- **OS:** [e.g., Windows 11, macOS 14] +- **Browser:** [e.g., Chrome 120, Firefox 121] +- **Node.js:** [e.g., 20.10.0] +- **ContextWeaver version:** [e.g., commit hash or tag] + +## API Used (if applicable) + +- **API URL:** [e.g., https://petstore3.swagger.io/api/v3/openapi.json] +- **Spec format:** [OpenAPI 3.0 / Swagger 2.0] + +## Additional Context + + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..e8b75f5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,27 @@ +--- +name: โœจ Feature Request +about: Suggest an idea for ContextWeaver +title: "[Feature]: " +labels: enhancement +assignees: '' +--- + +## Problem Statement + + + +## Proposed Solution + + + +## Alternatives Considered + + + +## Use Case + + + +## Additional Context + + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..c196f83 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,38 @@ +## Description + + + +## Type of Change + +- [ ] ๐Ÿ› Bug fix (non-breaking change that fixes an issue) +- [ ] โœจ New feature (non-breaking change that adds functionality) +- [ ] ๐Ÿ’ฅ Breaking change (fix or feature that would cause existing functionality to change) +- [ ] ๐Ÿ“ Documentation update +- [ ] ๐ŸŽจ Style / UI update +- [ ] โ™ป๏ธ Refactor (no functional changes) +- [ ] ๐Ÿงช Test update + +## Related Issues + + + +## How Has This Been Tested? + + + +- [ ] `npm run build` passes +- [ ] Manual testing in browser +- [ ] Tested with PetStore API +- [ ] Tested dark/light mode + +## Screenshots (if applicable) + + + +## Checklist + +- [ ] My code follows the project's style guidelines +- [ ] I have performed a self-review of my code +- [ ] I have added comments for complex logic +- [ ] My changes generate no new warnings +- [ ] The production build (`npm run build`) succeeds diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..4d5546a --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,57 @@ +# 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: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior: + +* The use of sexualized language or imagery, and sexual attention or advances +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information without explicit 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 in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +**faizanuddinsk56@gmail.com**. + +All complaints will be reviewed and investigated promptly and fairly. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), +version 2.1, available at +[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html). diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 31031ba..f68801a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,6 +2,8 @@ Thank you for your interest in contributing to ContextWeaver! This document provides guidelines and instructions for contributing. +Please note that this project is released with a [Contributor Code of Conduct](./CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms. + ## ๐ŸŽฏ Ways to Contribute - ๐Ÿ› Report bugs and issues @@ -25,7 +27,7 @@ Thank you for your interest in contributing to ContextWeaver! This document prov 1. **Fork and Clone** ```bash - git clone https://github.com/yourusername/contextweaver.git + git clone https://github.com/SKfaizan-786/contextweaver.git cd contextweaver ``` @@ -340,7 +342,9 @@ We pledge to make participation in our project a harassment-free experience for ### Enforcement -Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team. All complaints will be reviewed and investigated promptly and fairly. +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at **faizanuddinsk56@gmail.com**. All complaints will be reviewed and investigated promptly and fairly. + +See the full [Code of Conduct](./CODE_OF_CONDUCT.md) for details. ## ๐Ÿ™ Thank You!