search

VirtualFlyBrain / VFB2

Virtual Fly Brain Documentation Site
https://virtualflybrain.org
MIT License
2 stars 4 forks source link

readme

Virtual Fly Brain Docs

Welcome to the Virtual Fly Brain version 2 (VFB2) GitHub repository!

Static documentation site for www.VirtualFlyBrain.org

For the VFB 3D browser (geppetto) see https://github.com/VirtualFlyBrain/geppetto-vfb

Contributing

We welcome contributions from the community. If you're interested in contributing to the VFB project, there are several ways you can get involved:

  1. Reporting bugs or issues If you encounter any bugs or issues while using VFB2, please submit a new issue on our GitHub repository. When submitting a new issue, please be as descriptive as possible and include any relevant screenshots, error messages, or steps to reproduce the issue.

  2. Fixing bugs or issues If you have the skills and knowledge to fix a bug or issue in VFB2, we welcome your contributions! To get started, browse our list of open issues and pick one that you are interested in. Once you have fixed the issue, submit a pull request with your changes.

  3. Adding new features or enhancements If you have ideas for new features or enhancements to VFB2, we would love to hear them! Please submit a new issue on our GitHub repository with your proposal. If your proposal is approved, you can then work on implementing it and submit a pull request with your changes.

  4. Contributing to the documentation Documentation is an important part of any software project, and we welcome contributions to our documentation as well. If you notice any errors or omissions in our documentation, or if you have ideas for how to improve it, please submit a pull request with your changes.

You can also directly edit pages on the VFB doc site using the links on the right-hand side of each page. This allows you to quickly fix any errors or make small updates without needing to clone the repository and make a pull request.

  1. Translating VFB2 We welcome contributions to translate VFB2 into different languages. If you are interested in translating VFB2, please submit a pull request with your translations.

We look forward to your contributions and thank you for your support of the VFB project!

Directly editing pages on the VFB site

Did you know that you can directly edit pages on the VFB site? Simply click on the "Edit this page" link on the right-hand side of any page to make changes. Your changes will be submitted as a pull request on GitHub, where they will be reviewed by our team before being merged into the main branch.

Code of Conduct

We expect all contributors to abide by our Code of Conduct. Please take a moment to read it before contributing to the project.

License

The VFB project is licensed under the MIT License. See LICENSE for more information.