dev:starting
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
dev:starting [2019/03/05 16:18] – [Prepare the patch] tmueller | dev:starting [2020/04/17 11:38] – tmueller | ||
---|---|---|---|
Line 4: | Line 4: | ||
Documentation improvements, | Documentation improvements, | ||
- | CP2K is a large project, there is no way to study the full code, and start when that is done! Start working on small patches first, that are easy to code, to test and to integrate. Small patches are easier to review and thus will be more quickly merged to the Git master branch. As experience with the code grows, tackling larger projects becomes realistic. Developers | + | CP2K is a large project, there is no way to study the full code, and start when that is done! Start working on small patches first, that are easy to code, to test and to integrate. Small patches are easier to review and thus will be more quickly merged to the Git master branch. As experience with the code grows, tackling larger projects becomes realistic. Developers |
===== Prepare the patch ===== | ===== Prepare the patch ===== | ||
+ | |||
- Fork the CP2K Repository on GitHub via " | - Fork the CP2K Repository on GitHub via " | ||
- | | + | |
- On your machine, clone the repository via **git clone %%--%%recursive https:// | - On your machine, clone the repository via **git clone %%--%%recursive https:// | ||
- | - Move to the downloaded | + | - Change into the created |
- Start working in a new branch: **git checkout -b my-new-feature** | - Start working in a new branch: **git checkout -b my-new-feature** | ||
- Make your changes to the code | - Make your changes to the code | ||
Line 19: | Line 20: | ||
- Do some more work, then repeat point 6. and 7. | - Do some more work, then repeat point 6. and 7. | ||
- Push your new changes to the remote repository via **git push** (note: the '-u origin my-new-feature' | - Push your new changes to the remote repository via **git push** (note: the '-u origin my-new-feature' | ||
+ | - Use the GitHub interface at https:// | ||
+ | |||
+ | ===== Update your copy of the master/ | ||
+ | |||
- To update the ' | - To update the ' | ||
- tell your local git repository once about the remote: **git remote add upstream https:// | - tell your local git repository once about the remote: **git remote add upstream https:// | ||
- make sure you are on the right branch: **git checkout master** | - make sure you are on the right branch: **git checkout master** | ||
- ' | - ' | ||
- | - push the changes: **git push** | + | - To update a branch with patches onto the updated master |
- | - You can also rebase your feature | + | |
- **git checkout my-new-feature** | - **git checkout my-new-feature** | ||
- | - **git pull %%--%%rebase | + | - **git rebase master**, this may generate rebase/ |
- after a rebase of a branch with commits which was already pushed to a remote, you have to force-push: **git push %%--%%force** | - after a rebase of a branch with commits which was already pushed to a remote, you have to force-push: **git push %%--%%force** | ||
+ | |||
===== Submit the patch ===== | ===== Submit the patch ===== | ||
dev/starting.txt · Last modified: 2022/12/16 09:27 by krack