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 13:04] – [Prepare the patch] alazzaro | dev:starting [2020/04/17 13:46] – 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 | ||
- Add new and changed files: **git add ...** | - Add new and changed files: **git add ...** | ||
- Commit the changes: **git commit** | - Commit the changes: **git commit** | ||
- | - Please follow the [[https:// | + | - Please follow the [[https:// |
- Do the first push to your fork, give the remote branch the same name as the local one: **git push -u origin my-new-feature** | - Do the first push to your fork, give the remote branch the same name as the local one: **git push -u origin my-new-feature** | ||
- 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' | ||
- | - To update the ' | + | |
+ | |||
+ | ===== Update your copy of the master/ | ||
+ | |||
+ | | ||
- 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** | ||
- | - rebase' | + | |
+ | - To update a branch with patches onto the updated master branch: | ||
+ | - **git checkout my-new-feature** | ||
+ | - **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** | ||
===== Submit the patch ===== | ===== Submit the patch ===== | ||
Line 40: | Line 50: | ||
- Are proper citations added the bibliography ? | - Are proper citations added the bibliography ? | ||
- if any of the above steps required changes to the code, go back to the first step, otherwise go to the next step. | - if any of the above steps required changes to the code, go back to the first step, otherwise go to the next step. | ||
- | - the main process | + | - go to https:// |
- | - we use **git rebase** to keep the [[https:// | + | - you can check the status of your PR at https:// |
+ | - we use 'rebase' | ||
+ | - the PR will trigger the [[https:// | ||
+ | - In the case of success, the PR will be merged by one of the CP2K administrators | ||
+ | - In the case of error, please check what's wrong in the CI logs, fix it in your branch, and commit/push again. The CI will automatically rerun on the new version of the code (no need to close the PR, it will be automatically updated!). Repeat until the CI runs fine. | ||
+ | |||
+ | ===== Prepare a development environment with Spack ===== | ||
+ | |||
+ | The HPC package manager [[https:// | ||
+ | |||
+ | <note important> | ||
+ | |||
+ | - change into the CP2K directory: '' | ||
+ | - create a Spack environment (here for building an '' | ||
+ | - activate the Spack environment using: '' | ||
+ | - install everything required for CP2K and build & install CP2K from the current source tree (this may take while): '' | ||
+ | - start a new shell with all the environment variables set using '' | ||
+ | - to recompile, run: '' | ||
+ | If you experience problems with other tools (like your editor) when inside the Spack environment, |
dev/starting.txt · Last modified: 2022/12/16 09:27 by krack