Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
L
lammps
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container Registry
Model registry
Operate
Environments
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
multiscale
lammps
Commits
fe14158c
Commit
fe14158c
authored
8 years ago
by
Axel Kohlmeyer
Browse files
Options
Downloads
Patches
Plain Diff
some formatting updates and text rewrites in the "do not use git add -a" section
parent
0bcbcca1
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
doc/src/tutorial_github.txt
+37
-31
37 additions, 31 deletions
doc/src/tutorial_github.txt
with
37 additions
and
31 deletions
doc/src/tutorial_github.txt
+
37
−
31
View file @
fe14158c
...
...
@@ -53,17 +53,18 @@ can include changes from upstream into your repository.
[Adding changes to your own fork]
Additions to the upstream version of LAMMPS are handled using {feature
branches}.
For every new feature, a so-called feature branch is
created, which contains only
those modification relevant to one specific
feature. For example, adding a single
f
ix would consist of creating a branch with only the fix header and source file
and nothing else.
It is
explained in more detail here: "feature branch
Additions to the upstream version of LAMMPS are handled using {feature
branches}.
For every new feature, a so-called feature branch is
created, which contains only
those modification relevant to one specific
f
eature. For example, adding a single fix would consist of creating a
branch with only the fix header and source file
and nothing else.
It is
explained in more detail here: "feature branch
workflow"_https://www.atlassian.com/git/tutorials/comparing-workflows/feature-branch-workflow.
[Feature branches]
First of all, create a clone of your version on github on your local machine via HTTPS
First of all, create a clone of your version on github on your local
machine via HTTPS
$ git clone https://github.com/<your user name>/lammps.git <some name> :pre
...
...
@@ -111,17 +112,19 @@ After everything is done, add the files to the branch and commit them:
$ git add doc/src/tutorial_github.txt
$ git add doc/src/JPG/tutorial_*.png :pre
IMPORTANT NOTE: Do not use `git commit -a`. The -a flag will automatically
include _all_ modified or new files and that is rarely the behavior you want.
It can easily create to accidentally adding unrelated and unwanted changes into
the repository. It is highly preferable to explicitly use `git add`, `git rm`,
`git mv` for adding, removing, renaming files, respectively, and then `git
commit` to finalize the commit. If you find doing this on the command line too
tedious, consider using a GUI, the one included in git distributions written in
Tk, i.e. use `git gui`.
IMPORTANT NOTE: Do not use `git commit -a`. The -a flag will
automatically include _all_ modified or new files and that is rarely the
behavior you want. It can easily lead to accidentally adding unrelated
and unwanted changes into the repository. Instead it is preferable to
explicitly use `git add`, `git rm`, `git mv` for adding, removing,
renaming files, respectively, and then `git commit` to finalize the
commit. If you find doing this on the command line too tedious,
consider using a GUI, for example the one included in git distributions
written in Tk, i.e. use `git gui` (on some Linux distributions it may
be required to install an additional package to use it).
After adding all files, the change can be committed with some
useful message
that explains the change.
After adding all files, the change
set
can be committed with some
useful message
that explains the change.
$ git commit -m 'Finally updated the github tutorial' :pre
...
...
@@ -213,23 +216,26 @@ repository will automatically become part of the pull request:
:c,image(JPG/tutorial_additional_changes.png)
This means you can add changes that should be part of the feature after filing the pull request,
which is useful in case you have forgotten them,
or if a developer has ruled that something needs to change before the feature can be accepted upstream.
After each push, the automated checks are run again.
This means you can add changes that should be part of the feature after
filing the pull request, which is useful in case you have forgotten
them, or if a developer has ruled that something needs to change before
the feature can be accepted upstream. After each push, the automated
checks are run again.
[Assignees]
There is also now an assignee label. If the request has not been reviewed
by any developer yet, it is not assigned to anyone. After revision, a developer
can choose to assign it to either a) you, b) a LAMMPS developer
(including him/herself) or c) Steve Plimpton (sjplimp).
Case a) happens if changes are required on your part.
Case b) means that at the moment, it is being tested and reviewed by a LAMMPS developer.
After review, the developer can choose to implement changes or suggest them to you.
Case c) means that the pull request has been assigned to the lead developer Steve Plimpton,
and means it is considered ready for merging.
There is an assignee label for pull requests. If the request has not
been reviewed by any developer yet, it is not assigned to anyone. After
revision, a developer can choose to assign it to either a) you, b) a
LAMMPS developer (including him/herself) or c) Steve Plimpton (sjplimp).
Case a) happens if changes are required on your part :ulb,l
Case b) means that at the moment, it is being tested and reviewed by a
LAMMPS developer. After review, the developer can choose to implement
changes or suggest them to you. :l
Case c) means that the pull request has been assigned to the lead
developer Steve Plimpton, and means it is considered ready for
merging. :ule,l
In this case, Axel assigned the tutorial to Steve:
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment