Github and Pull Requests - DCS-Skunkworks/dcs-bios GitHub Wiki

How to submit PR to the main DCS-BIOS repo

Table of contents

Workflow

workflow

Files of interest

  • <aircraft>.json
  • <aircraft>.jsonp
  • Addresses.h

Changing an <aircraft>.lua file might produce changes in other files. This depends on what has changed. A new control will change all of above files. If these files changes then include them in the pull request.

You generate the new files by either:

  • starting a DCS mission
  • compile the DCS-BIOS code via VS Code (requires local lua interpreter)

Fork DCS-BIOS to your own Github page

Click Fork and a dialog window will open.

fork1


Here just make sure that you are the owner of the fork.

fork2


This is how it should look now on your Github page.

fork3

Install Github Desktop and clone your fork

github_desktop

Login to your Github account in Github Desktop.

Create a directory in which your repositories will be.


In Github Desktop click Clone repository.

clone0


Select your DCS-BIOS fork from the list. Make sure Local path is correct. This is the main folder under which all Github Desktop cloned repos will be.

clone1


Select Contribute to parent project as you will submit PR to the original repository.

clone2

Editing code and creating a pull request

Use VS Code for editing. Read the information on how to properly setup VS Code to use the correct extensions.

Do the changes you want made. When file is saved it will show in Github Desktop. If any other changes are visible then inspect these in case you have modified them by accident.

pr1_crop


Enter a commit message describing the changes. Keep it brief and use the Description field for longer text.

Do not click Commit yet.

pr2_crop


Now create a new branch for your changes.

pr3


You can use the same text as you did for the commit message.

Click Create branch.

pr4


Bring your changes to the new branch.

pr5


You can now see the current branch and that it points to the new branch. Now you are ready to click the Commit button.

pr6_crop


This is how it looks after clicking Commit. Now click Publish branch.

pr7_crop


Now you want to create a pull request. You can to that from the menu or from your Github fork.

create_pr


This is the last step for you. When you have created the PR someone from the DCS-BIOS team will look at it and:

  • approve it
  • request changes
  • deny it

If you are requested to make changes, just commit and push the changes in Github Desktop and it will show in the PR.

pr9

Sync your fork

Once your PR has been merged you need to sync your fork and you can delete the branch from your local repository and from your Github account repository.

synch_fork

Delete your branches

When you know your work is merged there is no need to keep the branch any longer and you can delete it via Github Desktop.

delete_branch

The Yes delete this branch on the remote means the branch on your Github account fork. delete_branch2

Setup local lua interpreter

With a local lua interpreter you can in VS Code validate the code and generate the new JSON files and Addresses.h file. Visit this page for information on how to install it.

actions

⚠️ **GitHub.com Fallback** ⚠️