From 073a6847d9324222dc6a56410373849fb8654c7c Mon Sep 17 00:00:00 2001 From: Dillin Date: Mon, 25 Mar 2024 11:59:03 +0000 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..acc3270 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,29 @@ +# Contributing to the AI Chatbot Project + +We welcome contributions from the community! Whether it's reporting a bug, submitting a feature request, or making a pull request, your input is valuable to the AI Chatbot project. Here's how you can contribute: + +## Reporting Issues + +### Create a Detailed Issue +- **Visit our Issues page** and create a new issue. Please provide as much detail as possible to help us understand the problem. +- **Include steps to reproduce the issue**, expected outcomes, and actual outcomes. + +### Environment Details +- Mention your operating environment, including **OS**, **Node.js version**, **Docker version**, and any other relevant details that could help replicate the issue. + +### Logs and Error Messages +- If applicable, include any console logs or error messages to provide further insight into the issue. + +## Submitting Pull Requests + +### Fork the Repository +- Start by forking the `ai-chatbot` repository. + +### Create a New Branch +- Make your changes in a new git branch based on the `main` branch. + +### Commit Changes +- Commit your changes, adhering to the project's coding standards and commit message conventions. + +### Open a Pull Request +- Submit a pull request (PR) against the `main` branch of the `ai-chatbot` repository. Please provide a clear description of the changes and any other information that will help us review your PR.