Skip to content

Latest commit

 

History

History
77 lines (64 loc) · 2.64 KB

CONTRIBUTING.md

File metadata and controls

77 lines (64 loc) · 2.64 KB

Contributing Guidelines

Thank you for considering contributing to Yapper AI! We welcome all contributions that help improve the project and create a better experience for users. By participating in this project, you agree to abide by our Code of Conduct.

How to Contribute

Reporting Bugs

If you find a bug, please:

  1. Search existing issues to ensure it hasn’t already been reported.
  2. Create a new issue with the following details:
    • Title: A clear and descriptive title.
    • Description: Steps to reproduce the bug, expected behavior, and actual behavior.
    • Environment: Browser, operating system, and any other relevant context.

Suggesting Features

We’re always looking for new ideas! To suggest a feature:

  1. Search existing issues to avoid duplicates.
  2. Open a new issue and include:
    • Title: A concise summary of the feature.
    • Description: A detailed explanation of the feature and its benefits.

Improving Documentation

  • Found a typo or something unclear? Submit a pull request with your changes.
  • Documentation is located in the /docs directory.

Submitting Code Contributions

Prerequisites

  1. Ensure you have Node.js and npm installed.
  2. Fork the repository and clone it locally: 
    git clone https://github.com/YOUR_USERNAME/YapperAI.git
  3. Install dependencies: 
    npm install
  4. Create a new branch for your feature or fix: 
    git checkout -b feature/your-feature

Development Workflow

  1. Write clean, readable, and well-documented code.
  2. Test your changes thoroughly.
  3. Ensure your code follows our coding standards and passes linting: 
    npm run lint
  4. Commit your changes: 
    git commit -m "Add description of your changes"
  5. Push your branch to your fork: 
    git push origin feature/your-feature
  6. Open a pull request (PR) to the main branch:
    • Provide a clear title and description of your changes.
    • Include any relevant issue references (e.g., "Closes #123").

Code Review Process

  • A maintainer will review your PR and provide feedback if needed.
  • Please address review comments promptly.
  • Once approved, your PR will be merged into the main branch.

Coding Standards

  • Follow the DRY (Don’t Repeat Yourself) principle.
  • Write meaningful commit messages.
  • Use descriptive variable and function names.
  • Ensure components are reusable and modular.

Issues and Help

If you’re stuck, feel free to ask for help by commenting on an issue or tagging a maintainer in your pull request.

Thank you for contributing to Yapper AI! 🚀