936
edits
Development workflow: Difference between revisions
Jump to navigation
Jump to search
→When is a Fork needed:
(Distinguish between forks on Sourceforge vs local clones.) |
|||
| Line 18: | Line 18: | ||
# 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, | # 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. | ##'''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, | ## pull the changes from upstream, remove your local branch and push to origin. | ||
== When is a Fork needed: == | == When is a Fork needed and when it's not: == | ||
If you are contributing changes to Flightgear, you need a fork of the official Flightgear reposotories on SourceForge. | 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. | 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. | ||
== Specific Steps == | |||
# Create a ED25519 or ECDSA key for use with Sourceforge | |||
# Update Sourceforge with the contents of your public key file. | |||
# Create Sourceforge forks of flightgear-flightgear and flightgear-simgear | |||
# Create a working directory for your work, possibly an IDE project directory | |||
# Clone your forks <nowiki>https://git.code.sf.net/p/flightgear/simgear</nowiki> flightgear-simgear and <nowiki>https://git.code.sf.net/p/flightgear/flightgear</nowiki> flightgear-flightgear | |||
# Establish upstream remote | |||
# Create a branch or branches for your work | |||
# Discuss changes on flightgear-devel mailing list | |||
# Request Merge when ready | |||
# Pull changes from upstream next | |||
# Wait for bugs to appear, revise your branch and Merge again | |||
# Later, Optionally, Remove local changes branch and push to origin | |||
== Scenery and aircraft contributions == | == Scenery and aircraft contributions == | ||