Skip to content

Latest commit

 

History

History
executable file
·
112 lines (71 loc) · 3.68 KB

CONTRIBUTING.md

File metadata and controls

executable file
·
112 lines (71 loc) · 3.68 KB
Raw

Contributing Guidelines

Welcome! We appreciate your interest in contributing to our open-source project. By contributing, you are helping us make this project even better. Please take a moment to review these guidelines to ensure a smooth and productive collaboration.

Table of Contents

  1. Getting Started
  2. Contributor Workflow
  1. Community
  2. License

Getting Started

Code of Conduct

Before you start contributing, please read and adhere to our Code of Conduct. We are committed to providing a safe and welcoming environment for all contributors.

How to Contribute

  1. Fork the repository: Click the "Fork" button on the top right corner of this page.

  2. Clone your fork: Clone your forked repository to your local machine.

    git clone https://github.com/SynaLinks/HybridAGI.git

  3. Create a new branch: Create a new branch to work on your feature or bug fix.

    git checkout -b my-feature-branch

  4. Make your changes: Make the necessary changes, following our Coding Guidelines.

  5. Test your changes: Ensure your changes pass all tests (if applicable).

  6. Commit your changes: Commit your changes with a clear and concise message.

    git commit -m "Add my new feature"

  7. Push your changes: Push your changes to your forked repository.

    git push origin my-feature-branch

  8. Open a Pull Request: Go to the original repository and create a Pull Request from your branch to the main branch.

Contributor Workflow

Bug Reports

If you encounter a bug in our project, please open a new issue and provide the following information:

  • A clear and descriptive title.
  • A detailed description of the bug.
  • Steps to reproduce the bug.
  • Your operating system and software versions.

Feature Requests

We welcome new feature ideas! Please open a new issue and provide the following information:

  • A clear and descriptive title.
  • A detailed description of the new feature.
  • Use cases or scenarios where the feature would be beneficial.

Pull Requests

We encourage you to contribute by opening Pull Requests (PRs). PRs should:

  • Have a clear and descriptive title.
  • Include a summary of the changes made.
  • Reference any relevant issues.

Community

Join our community on Discord to connect with other contributors and users, ask questions, and share your experiences.

License

By contributing to this project, you agree that your contributions will be licensed under the LICENSE of this project.

Thank you for contributing to HybridAGI!