-
Notifications
You must be signed in to change notification settings - Fork 4
Typo fixes within the browser
Drew Lewis edited this page Jul 22, 2024
·
6 revisions
Small fixes to text, e.g. to fix a typo, can be quickly made within the web browser using the steps below. We suggest to use the full authoring via Codespaces if you are changing anything more significant, so that you can preview your edits.
As an example, an issue was created that pointed out a typo of a single character. This should be an easy fix within the browser.
- From the main repository page, select the directory for the book you are fixing the typo in. This was Linear Algebra, so we'll go there.
- Navigate down the file structure to the source file. First click on
source
, then the relevant module (in this case applications), then the section.
- Either scroll through the source, or use the search function (CTRL+F or CMD+F in most browsers) to find the line of code you need to fix. Take note of this line number!
- In the top right, hit the pencil icon to edit the file.
- Scroll down to the line number you noted, and make the change. Then hit the green "Commit changes" button in the top right.
- Enter a commit message. Usually something short like "Fix typo" is fine, but if you do something else describe that. Then hit the green "Propose Changes" button.
- Github automatically takes you to a page to open a pull request. If needed, you can add a description (often this is unnecessary for a typo fix, but since there was an issue related to this it is noted here). You can also choose a reviewer on the right. Then hit the green "Create Pull Request" button.
- That's it! Now a maintainer will review and merge your fix into the book. If they have questions or comments on your contribution, they will be left on the pull request and you should receive an email notification from Github.