936
edits
Development workflow: Difference between revisions
Jump to navigation
Jump to search
Distinguish between forks on Sourceforge vs local clones.
(Restructuring; work in progress) |
(Distinguish between forks on Sourceforge vs local clones.) |
||
| Line 12: | Line 12: | ||
<!-- TODO: add links to the relevant Wiki pages --> | <!-- TODO: add links to the relevant Wiki pages --> | ||
# ''' | # '''Fork the repositories you would like to contribute to.''' In this context, a ''fork'' is a personal copy of the original repository created for your proposed modifications until they are accepted into the project. It is created on the same infrastructure as the official repositories. | ||
# '''Perform the desired modifications''' and | # '''Clone the forks of the repositories.''' A clone is a local copy of a fork, kept in sync with changes in the offical repositories. You will need to clone the fork repository to your local machine which create a copy of its data to your computer. This will establish the fork as a remote repository named "origin" | ||
# '''Establish the original repositories as an "upstream" remote.''' Updates in the upstream remote can be pulled into your local clone. | |||
#'''Perform the desired modifications locally in a branch''' and push them to your clone. | |||
# When you are ready to get your work accepted, '''submit a merge request'''. A developer will check your contribution before merging it into the project repositories. Fix any issues that are found during the review. | # When you are ready to get your work accepted, '''submit a merge request'''. A developer will check your contribution before merging it into the project repositories. Fix any issues that are found during the review. | ||
# Once your work is included, '''monitor the [[FlightGear build server|build server]], the [[ | # Once your work is included, | ||
## '''monitor the [[FlightGear build server|build server]], the [[mailing lists]] and the forum''' to check for bugs you might have inadvertently introduced. | |||
## pull the changes from upstream, emove your local branch and push to origin. | |||
== When is a Fork needed: == | |||
If you are contributing changes to Flightgear, you need a fork of the official Flightgear reposotories on SourceForge. | |||
If you are not contributing, and only wish to build flightgear, you do not need a fork. Instead, you should simply clone the official Flightgear Repositories as origin. In this case, an upstream remote connection is unnecessary. | |||
== Scenery and aircraft contributions == | == Scenery and aircraft contributions == | ||