Skip to content

DeepChat Contribution Guidelines

Jump to bottom
zerob13 edited this page Feb 22, 2025 · 1 revision

Contribution Guidelines

Welcome to contribute to DeepChat! This guide aims to provide all developers (both internal team members and external contributors) with clear development specifications and Issue/PR handling workflows. It will help us collaborate more efficiently and ensure project quality.

Branching Strategy

For Internal Team Members

  • Bug Fixes & Minor Feature Enhancements

    • Please develop directly on the dev branch.
    • Ensure that code submitted to the dev branch is basically functional and free of compilation errors (at least it should start normally with npm run dev).

  • Major Feature Additions or Refactoring

    • Please create a new branch, named in the format feature/featurename (where featurename is the specific feature name).
    • After development is complete, merge the feature/featurename branch into the dev branch.

For External Contributors

  • Please fork this project to your personal repository first.
  • Develop in your forked repository. Once development is complete, submit a Pull Request (PR).
  • Target your PR to the dev branch and describe which Issues you have fixed in the description (if applicable).

Issue Handling Process

  • Issue Submission

    • Before submitting an Issue, please search to see if similar issues or discussions already exist to avoid duplicates.
    • When describing the issue, please provide detailed steps to reproduce, expected behavior, and actual behavior.

  • Issue Linking

    • If your PR resolves a specific Issue, please link the corresponding Issue in your commit message or PR description.

  • Maintainer Follow-up

    • Project maintainers will regularly review Issues and provide feedback. Thank you for your contributions and patience!

Code Commit Guidelines

  • Code Style

    • Please follow the existing code style of the project to keep the code clean and consistent. (eslint)

  • Commit Message

    • Commit messages should be concise and accurately describe the changes made. When fixing Issues, link the relevant Issue(s).
    • Ensure that each commit is functionally complete and runnable.

  • Local Testing

    • Before committing, please ensure that all functionalities work properly locally.

Pull Request Process

  • Before Creating a PR

    • Please ensure your branch code has been thoroughly self-tested and has no compilation errors.

  • PR Description

    • Describe in detail the content of this change, its purpose, and its impact on existing functionalities.
    • If it fixes an Issue, please link the corresponding Issue in the description.

  • Code Review

    • Maintainers will review your code and may suggest modifications.
    • Once reviewed and approved, your code will be merged into the dev branch.

Other Notes

  • Communication & Collaboration

    • If you have any questions about the development process or code guidelines, please raise them in an Issue or contact the project maintainers.

  • Documentation Updates

    • If you find any documentation is incomplete or have suggestions for improvement during development, you are also welcome to submit relevant PRs.

  • Thank You for Contributing!

    • Every contributor's effort greatly promotes the project's development. Thank you for your enthusiasm and support!
    • We hope that with everyone's joint efforts, this project will continue to improve, become more stable, and more efficient.
    • We welcome everyone to provide feedback and suggestions to build a better project together!
Clone this wiki locally