Introduction
This ‘How to’ is designed to help get you started editing content using the GitHub website.
GitHub stores a lot of FreeSewing content, it allows anyone to suggest edits, and helps the contributors to review and implement approved changes.
If you are new to GitHub, you will need to create an account (they are free).
It is also possible to make changes using the GitHub desktop application and/or your computer’s command line; these advanced topics are beyond the scope of this ‘How to’.
All pattern instructions and web pages (including this ‘How to’) are written in Markdown. Please see our Markdown guide for more information on this.
For security, most contributors don’t have permission to change the code. Instead we must follow three steps to make edits:
- Fork (create a copy of) the repository. This will be your own copy and you can make all the changes you want.
- Make the edits.
- Save your edits and submit a pull request to let the admins know about your changes. This says “hey, I made some changes. I think you might like them and consider them for inclusion into your (original) repository.”
The GitHub documentation provides a more detailed explanation, but this guide should be enough to help you get started.
Fork the repository
- On GitHub.com, navigate to the FreeSewing repository
- In the top-right corner of the page, click Fork
- Click the Create fork button.
Make the edits
- Navigate to the folder containing the file that you want to edit.
To help you understand how the repository is organised, here is the path to the
Simone instructions:
freesewing/markdown/org/docs/patterns/simone/instructions This folder
contains several files, one for each language.
- Select on the file you want to update.
Please only edit the English language files (called en.md),
our translation software will handle the other languages.
Read more about translations in our translation guide.
- Click on the Edit button.
Clicking Preview will show what your changes will look like.
Save your edits and submit a pull request
When you are happy with your edits:
- Scroll to the bottom of the page and enter a brief description of your edits. This will help us know what has changed.
- Click the Commit changes button. This is similar to saving a snapshot of
your edits.
Now you will create a pull request to let the admins know your edits are ready for review:
- Navigate to the repository where you created your fork.
- Above the list of files, click the Pull request button.
Congratulations - you have just submitted your first edits to the site maintainers!
You can keep track of the progress of your changes in GitHub or in the
github-updates
channel on
our Discord server.
