Difference between revisions of "Simple Pull Request"
From GnuCash
m (Typo) |
m (→Procedure - fix typo Don'nt -> Don't) |
||
| (4 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
It is possible to create simple '''pull requests''' ('''PR''') using GitHubs web interface without setting up a local Git repository. | It is possible to create simple '''pull requests''' ('''PR''') using GitHubs web interface without setting up a local Git repository. | ||
;Requirements: Only a web browser. | ;Requirements: Only a web browser. | ||
| − | ;Use Cases: You want to fix a typo, upload a translation, ... | + | ;Use Cases: You want to fix a typo, upload a new translation<ref>For updates of existing translations please use [{{URL:wl}} Weblate] to avoid conflicts.</ref>, ... |
;Downside: To update your fork, you have to delete it (if there are no open PRs) and fork it again. | ;Downside: To update your fork, you have to delete it (if there are no open PRs) and fork it again. | ||
For more complex cases see [[Setup for Pull Requests]]. | For more complex cases see [[Setup for Pull Requests]]. | ||
| Line 7: | Line 7: | ||
==Procedure== | ==Procedure== | ||
| − | #[https://github.com/join Create a Github account] or [https://github.com/login log in] and use the excellent GitHub Help in the | + | #[https://github.com/join Create a Github account] or [https://github.com/login log in] and use the excellent GitHub Help in the following steps. |
| − | # | + | #Open the desired [https://github.com/Gnucash Gnucash] or [https://github.com/finance-quote/ finance-quote] repository file you want to change. |
| − | # | + | #Click the '''pencil''' icon on the top right hand side to ''Edit the file in your fork of this project'', search for text near the location, make any edits you want then 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. |
| − | # | + | #GitHub will create a copy of the repository (actually a branch) in your account. Click the '''Create pull request''' button. |
| − | #Create | + | #Give the ''Pull Request'' a description and add any comments then click '''Create pull request''' button. |
#Wait for comments and apply potential change requests by the core developers. | #Wait for comments and apply potential change requests by the core developers. | ||
| − | #After the PR | + | #;/!\:Don't use GitHub's Sync option. It would merge maint into your PR. That would insert much noise and make it harder to read your PR by the reviewers. When they accept your PR, they can rebase it on the recent maint branch. |
| + | #After the PR is merged (or closed for other reasons) you can remove your fork or branch. | ||
| + | |||
| + | ==Notes, References== | ||
| + | <references/> | ||
Latest revision as of 00:51, 28 September 2022
It is possible to create simple pull requests (PR) using GitHubs web interface without setting up a local Git repository.
- Requirements
- Only a web browser.
- Use Cases
- You want to fix a typo, upload a new translation[1], ...
- Downside
- To update your fork, you have to delete it (if there are no open PRs) and fork it again.
For more complex cases see Setup for Pull Requests.
Procedure
- Create a Github account or log in and use the excellent GitHub Help in the following steps.
- Open the desired Gnucash or finance-quote repository file you want to change.
- Click the pencil icon on the top right hand side to Edit the file in your fork of this project, search for text near the location, make any edits you want then 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.
- GitHub will create a copy of the repository (actually 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 button.
- Wait for comments and apply potential change requests by the core developers.
- /!\
- Don't use GitHub's Sync option. It would merge maint into your PR. That would insert much noise and make it harder to read your PR by the reviewers. When they accept your PR, they can rebase it on the recent maint branch.
- After the PR is merged (or closed for other reasons) you can remove your fork or branch.
