explain setup with dedicated user branches and git worktrees #400
Open
chdoc wants to merge 1 commit intoTalonCommunity:mainfrom
Open
explain setup with dedicated user branches and git worktrees #400chdoc wants to merge 1 commit intoTalonCommunity:mainfrom
chdoc wants to merge 1 commit intoTalonCommunity:mainfrom
Conversation
…ributing to community
✅ Deploy Preview for talon-wiki-refactor ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
|
||
| ### Managing Custom Changes and Contributing to the Main Repository Using Git | ||
|
|
||
| If you continue to use Talon for an extended period, you will most likely want to make changes to your configuration. In order to facilitate the integration of changes in the community repository with your own changes, it is strongly recommended to use Git for managing your changes. However, doing so requires more knowledge about Git than can be reasonably explained in a short guide like this. The [Pro Git](https://git-scm.com/book/en/v2) book is an excellent resource to learn about intermediate and advanced Git usage. |
Contributor
There was a problem hiding this comment.
Suggested change
| If you continue to use Talon for an extended period, you will most likely want to make changes to your configuration. In order to facilitate the integration of changes in the community repository with your own changes, it is strongly recommended to use Git for managing your changes. However, doing so requires more knowledge about Git than can be reasonably explained in a short guide like this. The [Pro Git](https://git-scm.com/book/en/v2) book is an excellent resource to learn about intermediate and advanced Git usage. | |
| If you continue to use Talon for an extended period, you will most likely want to make changes to your configuration. In order to facilitate the integration of changes in the community repository with your own changes, it is strongly recommended to use Git for managing your changes. However, doing so requires more knowledge about Git than can be reasonably explained in a short guide like this. The [Pro Git](https://git-scm.com/book/en/v2) site is an excellent resource to learn about intermediate and advanced Git usage. |
|
|
||
| If you continue to use Talon for an extended period, you will most likely want to make changes to your configuration. In order to facilitate the integration of changes in the community repository with your own changes, it is strongly recommended to use Git for managing your changes. However, doing so requires more knowledge about Git than can be reasonably explained in a short guide like this. The [Pro Git](https://git-scm.com/book/en/v2) book is an excellent resource to learn about intermediate and advanced Git usage. | ||
|
|
||
| #### Putting Custom Changes Onto Is Their Own Branch |
Contributor
There was a problem hiding this comment.
Suggested change
| #### Putting Custom Changes Onto Is Their Own Branch | |
| #### Putting Custom Changes Onto Their Own Branch |
|
|
||
| 1. After cloning the repository, create and switch to a new branch (e.g. `git checkout -b custom`). | ||
| 2. If you make changes, commit them to this branch. Try to avoid creating commits that bunch together unrelated changes. | ||
| 3. In regular intervals, fetch changes from the upstream repository and merge the main branch into your custom branch. This may result in merge conflicts that then need to be resolved. |
Contributor
There was a problem hiding this comment.
Maybe drop a link to the upgrade knausj script?
Contributor
There was a problem hiding this comment.
|
|
||
| #### Using Git Worktrees and Cherry-Picking to Contribute to the Upstream Repository | ||
|
|
||
| If you have made changes to your setup that could improve the experience for a wide range of users, you may want to share these changes with the wider community. If you have followed the recipe in the preceding section, Git makes it easy to create pull requests for your changes. One solution that is used by several regular contributors to `community` relies on Git worktrees and cherry-picking: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
There was recently a discussion on the Slack channel about how to set things up so one can maintain one's own changes and contribute to
community. I'm not entirely sure that this is the right page to add this information too, but it did not find anything better.