ICODE-ADC/lammps
4
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

git-svn-id: svn://svn.icms.temple.edu/lammps-ro/trunk@15410 f3b2605a-c512-4ea7-a41b-209d697bcdaa

Browse Source
This commit is contained in:
sjplimp
2016-07-30 16:09:11 +00:00
parent 5b5f839265
commit fd05571ee0
10 changed files with 97 additions and 65 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
doc/html/_sources/tutorial_github.txt
View File

@ -1,23 +1,21 @@
LAMMPS GitHub tutorial
**********************
======================
written by Stefan Paquay
========================
**written by Stefan Paquay**
----------
This document briefly describes how to use GitHub to merge changes
into LAMMPS using GitHub. It assumes that you are familiar with
This document briefly describes how to use GitHub to merge changes you
make into LAMMPS, using GitHub. It assumes that you are familiar with
git. You may want to have a look at the `Git book <http://git-scm.com/book/>`_ to reacquaint yourself.
----------
Making an account
*****************
**Making an account**
First of all, you need a GitHub account. This is fairly simple, just
go to `GitHub <https://github.com>`_ and create an account by clicking
@ -29,8 +27,7 @@ username or e-mail address and password.
----------
Forking the repository
**********************
**Forking the repository**
To get changes into LAMMPS, you need to first fork the repository. At
the time of writing, LAMMPS-ICMS is the preferred fork. Go to `LAMMPS on GitHub <https://github.com/lammps/lammps>`_ and make sure branch is
@ -54,14 +51,12 @@ can include changes from upstream into your repository.
----------
Adding changes to your own fork
*******************************
**Adding changes to your own fork**
Before adding changes, it is better to first create a new branch that
will contain these changes, a so-called feature branch.
Feature branches
================
**Feature branches**
Since LAMMPS is such a big project and most user contributions come in
small portions, the most ideal workflow for LAMMPS is the so-called
@ -126,8 +121,7 @@ After the files are added, the change should be comitted:
The "-m" switch is used to add a message to the commit. Use this to
indicate what type of change was commited.
Wisdom by Axel:
---------------
**Wisdom by Axel**
*"Do not use "git commit -a". the -a flag will automatically include
*all* modified or new files. mercurial does that and it find it
@ -204,8 +198,7 @@ request.
----------
Additional changes
******************
**Additional changes**
Before the pull request is accepted, any additional changes you push
into your repository will automatically become part of the pull
@ -215,8 +208,7 @@ request.
----------
After a merge
*************
**After a merge**
When everything is fine the feature branch is merged into the LAMMPS
repositories: