Skip to content

Contribute guideline

Jump to bottom
Vũ Tuấn Hải edited this page Sep 19, 2023 · 1 revision

How to contribute?

Instruction:

  1. Install Git or GitHub Desktop, and an editor such as Visual Studio Code.
  2. Send your GitHub username to haivt@uit.edu.vn, after that, I will add you as a collaborator in this repository.
  3. Clone your branch to your computer.
git clone https://github.com/vutuanhai237/UC-VQA.git
  1. Create a new branch (set name as your username) for your work and switch to your branch.
  2. Modify/add the code [Guideline later]
  3. Install all needed packages.
cd UC-VQA
pip install -r requirements.txt
  1. Test

Run all test case

cd tests
pytest

or reading details in the demos folder.

Testing and merging pull requests

Your pull request will be automatically tested by qtm Github Action (testing status can be checked here: https://github.com/vutuanhai237/UC-VQA/actions). If any builders have failed, you should fix the issue. No need to close pull request and open a new one! Once all the builders are "green", I will review your code.

Clone this wiki locally