Skip to content

Latest commit

 

History

History
144 lines (104 loc) · 7.19 KB

CONTRIBUTING.md

File metadata and controls

144 lines (104 loc) · 7.19 KB
Raw

Customer Support Bot: Contributing Guidelines 📄

Table of Contents

  1. Introduction
  2. Tech Stack
  3. Installation
  4. Contributing
  5. Resources for Beginners
  6. Documentation
  7. Code Reviews
  8. Feature Requests
  9. Spreading the Word
  10. Code of Conduct
  11. Thank You

Introduction 🖥️

Welcome to Customer Support Bot, a WordPress plugin that allows businesses to automate customer support using AI technology. We are excited to have you contribute to our project! No contribution is too small, and we appreciate your help in improving this plugin.

Tech Stack 🗃️

The project is built using the following technologies:

  • WordPress – CMS platform where the plugin is installed and activated.
  • PHP – Server-side language used to handle API interactions and WordPress plugin development.
  • JavaScript – Frontend logic for chatbot interaction.
  • Axios – Promise-based HTTP client used to interact with the Agentive API for AI communication.
  • Bootstrap – Frontend CSS framework for styling the admin settings page.
  • OpenAI API – An interface for integrating AI capabilities, enabling advanced natural language processing and generation features.

Installation ⚙️

You can install the Customer Support Bot plugin in two ways:

1. Download from GitHub

  • Go to the GitHub repository and download the repository as a ZIP file.
  • Navigate to your WordPress admin dashboard.
  • Go to Plugins > Add New > Upload Plugin.
  • Upload the ZIP file and click Install Now.
  • After installation, click Activate Plugin.

2. Clone the Repository

Alternatively, you can clone the repository using Git:

  1. Clone the repository: git clone https://github.com/dmotts/customer-support-bot.git
  2. Navigate to your WordPress plugin directory (usually located at /wp-content/plugins/).
  3. Copy the cloned repository folder into the plugin directory.
  4. Log in to your WordPress admin dashboard.
  5. Go to Plugins > Installed Plugins.
  6. Find Customer Support Bot in the list and click Activate.

Contributing 📝

We welcome contributions to Customer Support Bot! Please follow these guidelines to ensure a smooth contribution process.

Development Workflow

  • Work on a New Branch: Always create a new branch for each issue or feature you are working on.
  • Keep Your Branch Up to Date: Regularly pull changes from the master branch to keep your branch up to date.
  • Write Clear Commit Messages: Use descriptive commit messages to explain what your changes do.
  • Test Thoroughly: Ensure your changes work correctly and do not break existing functionality.
  • Self-Review: Review your code before submitting to catch any errors or areas for improvement.

Issue Report Process 📌

  1. Check Existing Issues: Before creating a new issue, check if it has already been reported.
  2. Create a New Issue: Go to the project's issues section and select the appropriate template.
  3. Provide Details: Give a clear and detailed description of the issue.
  4. Wait for Assignment: Wait for the issue to be assigned to you before starting work.

Pull Request Process 🚀

  1. Ensure Self-Review: Make sure you have thoroughly reviewed your code.
  2. Provide Descriptions: Add a clear description of the functionality and changes in your pull request.
  3. Comment Your Code: Comment on complex or hard-to-understand areas of your code.
  4. Add Screenshots: Include screenshots if they help explain your changes.
  5. Submit PR: Submit your pull request using the provided template, and wait for the maintainers to review it.

Contributing Using GitHub Desktop

If you prefer using GitHub Desktop, follow these steps:

  1. Open GitHub Desktop: Launch GitHub Desktop and log in to your GitHub account.
  2. Clone the Repository: Click on "File" > "Clone Repository" and select the repository to clone.
  3. Create a Branch: Click on "Current Branch" and select "New Branch" to create a new branch for your work.
  4. Make Changes: Edit the code using your preferred code editor.
  5. Commit Changes:
    • In GitHub Desktop, select the files you changed.
    • Enter a summary and description for your commit.
    • Click "Commit to [branch-name]".
  6. Push Changes: Click "Push origin" to push your changes to GitHub.
  7. Create a Pull Request:
    • On GitHub, navigate to your forked repository.
    • Click on "Compare & pull request".
    • Review your changes and submit the pull request.
  8. Wait for Review: Wait for the maintainers to review your pull request.

Resources for Beginners 📚

If you're new to Git and GitHub, here are some resources to help you get started:

Documentation 📍

  • Update Documentation: Document any significant changes or additions to the codebase.
  • Provide Clear Explanations: Explain the functionality, usage, and any relevant considerations.
  • Use Comments: Comment your code, especially in complex areas.

Code Reviews 🔎

  • Be Open to Feedback: Welcome feedback and constructive criticism from other contributors.
  • Participate in Reviews: Help review others' code when possible.
  • Follow Guidelines: Ensure your code meets the project's coding standards and guidelines.

Feature Requests 🔥

  • Suggest Improvements: Propose new features or enhancements that could benefit the project.
  • Provide Details: Explain the rationale and potential impact of your suggestion.

Spreading the Word 👐

  • Share Your Experience: Share the project with others who might be interested.
  • Engage on Social Media: Talk about the project on social media, developer forums, or relevant platforms.

Code of Conduct 📜

Please note that we have a Code of Conduct. By participating in this project, you agree to abide by its terms.

Thank You 💗

Thank you for contributing to Customer Support Bot! Together, we can make a significant impact. Happy coding! 🚀

Don't forget to ⭐ the repository!