Skip to content

Latest commit

 

History

History
32 lines (29 loc) · 3.85 KB

git_help.md

File metadata and controls

32 lines (29 loc) · 3.85 KB

Making a Pull Request to submit changes or new scripts to the official repository

Create a 'fork' of this repository on your own page by clicking the button that says 'Fork' in the top right, between 'Watch' and 'Starred' image
Navigate to your new fork by going to your profile. It will be listed as your_username/EuroPi instead of Allen-Synthesis/EuroPi image
Create a new branch to make your changes on. Simply click on the button that says 'main' and then type a new branch name relevant to your changes and click 'Create new branch: your-branch-name from main'. This step is very useful as it allows you to group together your changes. For example, you may be working on a script which you aren't quite ready to contribute yet, but you have just noticed a spelling mistake in the main repository that you want to fix. You can simply create a new branch named something like 'spelling-fixes', make your changes there, and then only make a Pull Request for that branch, leaving your script for a future PR. image
Make the relevant changes to your own fork, within the branch that you just created, either uploading files or changing existing ones image
IMPORTANT: Please write informative descriptions for all commits you make to your own fork so that it is obvious what changes you are making and why image
When you are happy with the changes you've made, click the tab in your own fork that says 'Pull Requests' and then click 'New Pull Request' image
Make sure that the branch of your fork that you are making a Pull Request for is the correct one for these changes. To change it, click where it says 'main' and then choose the correct branch from the drop-down image
Check all of the changes shown below are correct, then click 'Create Pull Request' image
Add a title and an overall description of the changes you are suggesting and/or the new files you've uploaded. This description should be informative but doesn't have to be too long if there are descriptions for each commit (as there should be) image
Please make sure that the checkbox 'Allow edits and access to secrets by maintainers' is turned on so that any small changes, such as spelling or grammar, can be completed by any of the maintainers before merging image
Finally, click 'Make Pull Request' image
Now wait for the review process to complete. You may need to make changes to your PR during this process, and you can read more about how reviews are carried out in the Contributing Guidelines
Once the Pull Request is merged, tell everyone about your cool new script or change in the Discord server! Join the Allen Synthesis Discord