How to contribute

Contributions to the multi-view-AE library are welcome and greatly appreciated! Here are some ways you can contribute:

Reporting a bug

If you are reporting a bug, please include the following information:

A quick summary and/or background.
Your operating system name and version.
Details about your local setup that might be helpful in troubleshooting e.g. python version, library versions
Detailed steps to reproduce the bug.
What you expected to happen.
What actually happens.

The best way to propose a new feature is by submitting an issue https://github.com/alawryaguila/multi-view-AE/issues

To propose a feature please include:

Describe in detail how the new feature would work.
Explain the use case of the new feature.
Please keep the scope as narrow and specific as possible, to make it easier to implement.

The latest documentation for the multi-view-AE library is available at https://multi-view-ae.readthedocs.io/en/latest/

If any documentation is unclear or requires correction, please submit an issue.

To submit your code when fixing bugs, documentation, or implementing new features, please follow the steps below.

Clone your fork locally:

$ git clone git@github.com:your_name_here/multi-view-AE.git

Create a branch for local development:

$ git checkout -b name-of-your-bugfix-or-feature

Make your desired changes on your local branch.

Commit your changes and push your branch to GitHub:

$ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature