Skip to content

Latest commit

 

History

History
70 lines (48 loc) · 2.51 KB

CONTRIBUTING.md

File metadata and controls

70 lines (48 loc) · 2.51 KB

Contributing to VisionaryAI

Thank you for your interest in contributing to VisionaryAI! We welcome all contributions, whether they are bug fixes, feature additions, documentation improvements, or any other form of enhancement.

Getting Started

  1. Fork the Repository:
    Start by forking the repository to your GitHub account.

  2. Clone Your Fork:
    Clone the forked repository to your local machine.

    git clone https://github.com/Abhrankan-Chakrabarti/GeminiFusion.git
cd GeminiFusion

  3. Create a Branch:
    Create a new branch to work on. Use a descriptive name for your branch that reflects the nature of your contribution.

    git checkout -b feature/your-feature-name

  4. Make Your Changes:
    Implement your changes in the codebase. Ensure your code follows the project's style guidelines and best practices.

  5. Test Your Changes:
    Test your changes thoroughly. If applicable, add unit tests to cover your new code.

  6. Commit Your Changes:
    Once you're satisfied with your changes, commit them. Write clear and concise commit messages.

    git add .
git commit -m "Add detailed description of your change"

  7. Push Your Changes:
    Push your branch to your forked repository.

    git push origin feature/your-feature-name

  8. Open a Pull Request:
    Go to the original repository on GitHub and open a pull request. Provide a clear description of your changes and the problem they address.

Code of Conduct

Please adhere to our Code of Conduct when contributing to this project.

Reporting Issues

If you encounter any issues, please report them using the issue tracker. Be sure to include a detailed description of the issue and steps to reproduce it.

Coding Standards

  • Follow the existing coding style in the project.
  • Keep your code clean and well-commented.
  • Write descriptive commit messages.
  • Ensure your changes do not introduce new bugs or performance issues.

Documentation

If your contribution adds or changes any features, please update the relevant documentation. This includes updating the README, docstrings, and any other relevant files.

Community

Join the conversation on our discussion board to ask questions, suggest new features, and engage with other contributors.

Thank you for contributing to VisionaryAI!