Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
T
technical-reference
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Model registry
Operate
Environments
Monitor
Incidents
Service Desk
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
FE
technical-reference
Commits
35dd062e
Commit
35dd062e
authored
4 years ago
by
Stefan E. Funk
Browse files
Options
Downloads
Patches
Plain Diff
Correct local build doc
parent
f34592ad
No related branches found
No related tags found
1 merge request
!31
Correct local build doc
Pipeline
#145408
passed with warnings
4 years ago
Stage: build
Stage: test
Changes
1
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+12
-4
12 additions, 4 deletions
README.md
with
12 additions
and
4 deletions
README.md
+
12
−
4
View file @
35dd062e
...
...
@@ -2,14 +2,21 @@
Guidelines and references for software development in RDD
To c
ompile
in markdown, use
To c
reate ma
in markdown
document and compile to PDF
, use
```
bash
pandoc
--template
=
rdd.latex rdd-technical-reference.md
-o
rdd-technical-reference.pdf
cat
technical-reference-main.txt |
while
read
LINE
;
do
cat
$LINE
>>
technical-reference.md
;
done
pandoc
--template
=
rdd.latex technical-reference.md
-o
technical-reference.pdf
```
Inspired by the
[
EURISE Network Technical Reference
](
https://github.com/eurise-network/technical-reference
)
.
## Sources and PDF
The sources and the PDF of this reference are available continuously with every release here: https://gitlab.gwdg.de/fe/technical-reference/-/releases
## Contributing
Commits have to be made following a certain convention that is defined by the
...
...
@@ -25,8 +32,7 @@ npm install
You can now run a commit using commitizen with
`git cz`
.
To run commitizen on
`git commit`
rather than on
`git cz`
, update or create
`.git/hooks/prepare-commit-msg`
with the
following code:
To run commitizen on
`git commit`
rather than on
`git cz`
, update or create
`.git/hooks/prepare-commit-msg`
with the following code:
```
bash
#!/bin/bash
...
...
@@ -41,3 +47,5 @@ that should reflect the extent of your contribution:
These commit types trigger a
`patch`
or
`minor`
release when merged into the
`master`
branch.
To trigger a
`major`
release, please consult your fellow contributors and mark one of your commits with a
`BREAKING CHANGE`
.
The
`master`
branch is protected for direct commits, so please use feature branches and do merge them into
`master`
.
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