Before we dive into editing anything, there are a few things you need to check first.
Don't worry! We've explained everything you need to know below.
Prerequisites
License Check
Original creators have spent plenty of time publishing the profile, so before you begin to make any changes you need to check the profile's license.
Explained
There are two types of license:
License
Description
CC BY-NC 4.0
Modifications Allowed
CC BY-NC-ND 4.0
NO Modifications Allowed
You are looking for CC BY-NC 4.0 in order to have the green light for modifications.
Instead of searching through files, we've complied a list of available profiles and their respective licenses. See Here
✅ If the profile you wish to update is listed as modifyable, then please continue here
❌ If it isn't, then please continue below...
Not Modifyable
If you reached this point, it means that the creator has indicated that they wish to reserve any modifications.
You are now in the position to offer suggestions/improvements or report any bugs via the GSX Hub/Profiles GitHub Page.
To do so, please follow this link
If you ask me, you may have dodged a bullet 😉 Profiles can be very tedious at times.
Completed the form?
Perfect!
The creator may respond and ask for further details, so please keep an eye out.
On behalf of the creators and GSX Hub, thank you for offering your support.
Modifyable
So the profile is listed as modifyable, let's get started!
Fork the repository by selecting Fork on the top bar
Clone your fork by selecting <> Code -> Copy Git URL
Note
Make sure it says forked from GSX-Hub/Profiles in the top left-hand corner before cloning it.
Visual Studio Code
Open Visual Studio Code and select Clone Git Repository then paste the URL into the top bar
Choose a suitable location to clone the repository to
Example
Something like Documents/GitHub/ would be sensible
Cloned the repository to your PC
Creating a branch
Inside of GitHub Desktop, ensure that the 'Current repository' is Profiles, the 'Current branch' is main and select New Branch.
Name your branch in accordance with the issue number: issue-12
Now that you have created the branch, we can begin to make the necessary changes.
Created a branch
Making the changes
Now that we have made the branch, you can make the changes required.
Using the text editor of your choice, edit the files and return to this section once you are complete.
Good Habits
Below are some good habits to get into when editing, some are GitHub related.
Tip
Description
Commit Periodically
Ideally you should be committing your changes regularly. For example, if I was to modify a group of stands (Terminal A), before I move to Terminal B stands I will commit the changes made. It allows for natural breaks in development and, if you publish the branch, others can help support and view your progress.
Ready to Upload?
Feel you've forgotten or messed something up? Don't worry - it will be checked before it goes live.
Open GitHub Desktop and notice the list of changes on the left-hand side. You can go through them and check to see if it has detected all your changes. If anything is missing, double check you have saved the file.
Name your commit. Since this is your first commit of the profile, I highly recommend naming it Initial Release. You may add a description should you wish.
Once you have selected Commit to... you can then select Publish Branch at the top. This will push the branch to GitHub and allow your changes to be compared against the main code.
To Complete
Creating a Pull Request (PR)
Now that the branch has been published to your GitHub Repo, it's time to make a Pull Request against the existing files.
Navigate back to the repository's main page. You should see this notification:
Click Compare & Pull Request. Fill out the PR form like the example below:
Tip
You must follow the PR schema. [ICAO] Developer | Fixes #[IssueNumber]
Example
[EGNX] Pyreegue | Fixes #12
When you are happy, submit the PR by clicking Create Pull Request.
