Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
82 lines (56 loc) · 3.17 KB

CONTRIBUTING.md

File metadata and controls

82 lines (56 loc) · 3.17 KB

Contributing to CometChat Documentation

Thank you for your interest in contributing to the CometChat documentation! We welcome contributions from the community to help improve our documentation and make it more valuable for all users.

Getting Started

The CometChat documentation is hosted at https://cometchat.com/docs and the source files are maintained in this repository.

Prerequisites

  • A GitHub account
  • Basic knowledge of Markdown
  • Familiarity with Git and GitHub workflows

How to Contribute

Reporting Issues

If you find an issue with the documentation, such as:

  • Inaccurate information
  • Missing content
  • Typographical errors
  • Broken links
  • Unclear explanations

Please submit an issue with the following information:

  • A clear title describing the issue
  • The URL or file path of the page where the issue is found
  • A detailed description of the issue
  • If possible, a suggestion for how to fix the issue

Submitting Changes

  1. Fork the repository to your GitHub account.
  2. Create a new branch from the main branch for your changes.
    • Use descriptive branch names following our branch naming convention
    • For community contributors: fix/description, docs/improvement-description, or community/contribution-description
    • Examples: fix/typo-in-getting-started, docs/clarify-authentication-steps, community/add-code-example
    • Note: feature/, release/, chore/ and hotfix/ branches are restricted to CometChat organization members only
  3. Make your changes to the documentation.
  4. Commit your changes with a clear commit message.
  5. Push your changes to your fork.
  6. Submit a pull request to the main repository.

Pull Request Process

  1. Ensure your PR has a clear title and description explaining the changes you've made.
  2. Link any related issues in the PR description using GitHub keywords (e.g., "Fixes #123").
  3. Your PR will be reviewed by the documentation team.
  4. Address any feedback or requested changes from reviewers.
  5. Once approved, your changes will be merged into the main branch.

Documentation Guidelines

Style Guide

  • Use clear, concise language
  • Write in present tense
  • Use active voice
  • Be inclusive and respectful
  • Follow the existing formatting and structure of the documentation

Markdown Formatting

  • Use ATX-style headings with a space after the # (e.g., # Heading 1)
  • Use backticks for inline code and triple backticks for code blocks
  • Include language identifiers with code blocks when applicable (e.g., ```javascript)
  • Use relative links for internal documentation references

Code of Conduct

Please note that this project is governed by our Code of Conduct. By participating, you are expected to uphold this code.

License

By contributing to the CometChat documentation, you agree that your contributions will be licensed under the same license as the repository.

Questions?

If you have any questions about contributing, please contact our support team or open an issue in the repository.