Skip to content

Latest commit

 

History

History
58 lines (42 loc) · 2.94 KB

CONTRIBUTING.md

File metadata and controls

58 lines (42 loc) · 2.94 KB
Raw

Contributing to Assistants Hub

First off, thank you for considering contributing to Assistants Hub! It's people like you that make Assistants Hub such a great tool. We welcome contributions from everyone as part of our mission to democratize AI assistant development. Here are some guidelines that we ask contributors to follow to make the process as smooth as possible.

Getting Started

  • Make sure you have a GitHub account.
  • Submit a ticket for your issue or feature request, assuming one does not already exist.
    • Clearly describe the issue, including steps to reproduce it.
    • If it's a new feature, explain why you think it would be a good addition to Assistants Hub.
  • Fork the repository on GitHub.

Making Changes

  • Create a topic branch from where you want to base your work.
    • This is usually the main branch.
    • Only target release branches if you are certain your fix must be on that branch.
    • To quickly create a topic branch: git checkout -b my_fix_branch main.
  • Make commits of logical and atomic units.
  • Check for unnecessary whitespace with git diff --check before committing.
  • Make sure your commit messages are in the proper format.
    • Start the commit message with a short summary (50 characters or less).
    • Provide a detailed description if necessary. Use markdown syntax in the description.
  • Make sure you have added the necessary tests for your changes.
  • Run all the tests to assure nothing else was accidentally broken.

Submitting Changes

  • Push your changes to a topic branch in your fork of the repository.
  • Submit a pull request to the Assistants Hub repository.
  • The core team will look at Pull Requests on a regular basis.
  • After feedback has been given, we expect responses within two weeks. After two weeks, we may close the pull request if it isn't showing any activity.

Reporting Bugs

  • Use GitHub Issues to report bugs for Assistants Hub.
  • Write detailed information:
    • Use a clear and descriptive title.
    • Describe the exact steps to reproduce the bug.
    • Provide specific examples to demonstrate the steps.
    • Describe the behavior you observed and what you expected.

Requesting Features

  • Use GitHub Issues to request features or suggest improvements for Assistants Hub.
  • Use a clear and descriptive title.
  • Provide a detailed explanation of the feature and its benefits.
  • Include any relevant examples or mockups.

Code Review Process

The core team looks at Pull Requests on a regular basis and provides feedback. After feedback has been given, we expect a response within two weeks. If there is no response from the contributor after two weeks, the pull request may be closed.

Community

We want to foster an inclusive and friendly community around Assistants Hub. We expect everyone to follow our Code of Conduct. Please make sure you read and understand it.

Thank you for contributing to Assistants Hub, and we look forward to your contributions!