devel:git-commit-guidelines
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| devel:git-commit-guidelines [2016/11/14 21:22] – [Rename and commit file] mslehto | devel:git-commit-guidelines [2018/10/24 20:33] (current) – [Read-Only Cloning of GIT Repository] henningw | ||
|---|---|---|---|
| Line 42: | Line 42: | ||
| The clone is tracking automatically the remote **master** branch (the development version). | The clone is tracking automatically the remote **master** branch (the development version). | ||
| + | |||
| + | ===== Working with Github forks of a GIT Repository ===== | ||
| + | |||
| + | If you don't have developer write access, you can fork the Kamailio repository. Then you checkout the forked repository to your local disk and do the changes. Commit the changes to your repository and create a pull request to integrate your changes into the Kamailio repository back. Have a look e.g. to this documentation: | ||
| + | |||
| + | [[https:// | ||
| + | |||
| + | [[https:// | ||
| ===== Read-Only Cloning of GIT Repository ===== | ===== Read-Only Cloning of GIT Repository ===== | ||
| + | |||
| + | **Working with a fork of the Kamailio repository and then submitting a pull request is nowadays the preferred way to integrate your contributions, | ||
| If you don't have developer write access, you can clone read-only the repository with: | If you don't have developer write access, you can clone read-only the repository with: | ||
| Line 166: | Line 176: | ||
| * do the commits per one module when changing in a module and other modules are affected and were updates as well | * do the commits per one module when changing in a module and other modules are affected and were updates as well | ||
| * when updating the documentation and it is intended to do a backport, split the commit in one for xml files and one for the README file. Usually the commit to xml files can be backported without conflict (with git cherry-pick ...). README files are many times generated with different character sets, a matter of the system where they are generated, resulting in backporting conflicts. Thus is better to backport only the commit for xml files and generate the README for that branch, then push it to remote GIT repository | * when updating the documentation and it is intended to do a backport, split the commit in one for xml files and one for the README file. Usually the commit to xml files can be backported without conflict (with git cherry-pick ...). README files are many times generated with different character sets, a matter of the system where they are generated, resulting in backporting conflicts. Thus is better to backport only the commit for xml files and generate the README for that branch, then push it to remote GIT repository | ||
| + | * **IMPORTANT**: | ||
| * if it is a change that has to be repeated in many places, then the commit can be done at once to all changes. For example, renaming a token that is present in all docbook files, removing or adding a new field in a structure such as module exports. | * if it is a change that has to be repeated in many places, then the commit can be done at once to all changes. For example, renaming a token that is present in all docbook files, removing or adding a new field in a structure such as module exports. | ||
devel/git-commit-guidelines.1479158555.txt.gz · Last modified: 2016/11/14 21:22 by mslehto