User Tools

Site Tools


dev:starting

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
Next revisionBoth sides next revision
dev:starting [2019/03/05 16:17] tmuellerdev:starting [2019/06/22 16:16] oschuett
Line 4: Line 4:
 Documentation improvements, bug fixes, performance enhancements, portability issues, new features, new methods ... you are encouraged to contribute so that the community as a whole can benefit. Documentation improvements, bug fixes, performance enhancements, portability issues, new features, new methods ... you are encouraged to contribute so that the community as a whole can benefit.
  
-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 that regularly contribute can sign up to the [[https://lists.cp2k.org/listinfo/cp2k-dev CP2K developer mailing list]].+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 who contribute regularly  can join the [[https://github.com/orgs/cp2k/teams/cp2k-developers developers team]] on Github.
  
 ===== Prepare the patch ===== ===== Prepare the patch =====
   - Fork the CP2K Repository on GitHub via "Fork" on https://github.com/cp2k/cp2k   - Fork the CP2K Repository on GitHub via "Fork" on https://github.com/cp2k/cp2k
      - Also as a member of the development team you will not be able to push directly to the `master` branch of the https://github.com/cp2k/cp2k repository. This is by intention and we would like to ask you to send changes as Pull Requests instead.      - Also as a member of the development team you will not be able to push directly to the `master` branch of the https://github.com/cp2k/cp2k repository. This is by intention and we would like to ask you to send changes as Pull Requests instead.
-  - On your machine, clone the repository via **git clone %%--%%recursive https://github.com/YOURUSERNAME/cp2k.git**+  - On your machine, clone the repository via **git clone %%--%%recursive https://github.com/YOURNAME/cp2k.git**
   - Move to the downloaded cp2k directory: **cd cp2k**   - Move to the downloaded cp2k directory: **cd cp2k**
   - Start working in a new branch: **git checkout -b my-new-feature**   - Start working in a new branch: **git checkout -b my-new-feature**
dev/starting.txt · Last modified: 2022/12/16 09:27 by krack