Differences

This shows you the differences between two versions of the page.

--- usage:faq [2020/04/01 12:44] – Links for FAQs flywire
+++ usage:faq [2020/04/03 23:11] (current) – GitHub search clarifications flywire
@@ Line 126: / Line 126: @@
 === Can I easily contribute on GitHub? ===
-**Yes**, with a simple //pull request//. You will need to register a GitHub account, login then go to the page. For example, click the //Edit on GitHub// link in the top right-hand corner of any User Manual page to go to the page.
+**Yes**, with a simple //pull request// (term to offer a change). You will need to register a GitHub account, login then go to the page. For example, click the //Edit on GitHub// link in the top right-hand corner of any User Manual page to go to the page.
-  * Click the **pencil** button, make any edits you want and preview them to confirm. Give the proposed change a description up to 50 characters and optionally an extended description then click the **Propose file Change** button.
+  * Click the **pencil** button, search for text near the location, make any edits you want then preview them to confirm (see Hints below). Give the proposed change a description up to 50 characters and optionally an extended description then click the **Propose file Change** button.
-  * If you're reading this you won't have write access to the repository so GitHub will create a copy of the repository as a branch of a fork in your account. Click the **Create pull request** button.
+  * If you're reading this you won't have write access to the repository (project folders) so GitHub will create a copy of the repository (actually a a branch) in your account. Click the **Create pull request** button.
-  * Give the //Pull Request// a description and add any comments then click **Create pull request**.
+  * Give the //Pull Request// a description and add any comments then click **Create pull request** button.
-Many GitHub files are in a special format, for example, the User Manual uses reStructuredText. If the change is simple you might be able to stay within existing formatting or perhaps copy a similar formatted section from elsewhere and change it. If you mess it up get help or submit it anyway and let the repository owner fix it.
+**Hints**
-Each contribution should have its own branch so just start again. If you missed something in the //pull request// just open up your repository fork branch, change it and commit a new change.
+Many GitHub files are in a special format, for example, the User Manual uses reStructuredText. Codes are used to format the document so a simple search in the browser will only find text formatted the same (and Chrome would search the file but Firefox would only search the screen). If the change is simple you might be able to stay within existing formatting, try a blank line before/after the change or perhaps copy a similar formatted section from elsewhere and change it. If you mess it up get help or submit it anyway and let the repository owner fix it.
+Each contribution should have its own branch so just start again. If you missed something in the //pull request// just open up your repository branch, change it and commit a new change.
 This process will only work for one file and you can repeat it for two. Complex Pull Requests involving multiple files should be submitted using Git.
 [[https://help.github.com/en/github/managing-files-in-a-repository/managing-files-on-github|Managing files on GitHub]]

Wiki

User Tools

Site Tools

Differences

Page Tools