Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
A
auto-tx
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
vamp
auto-tx
Commits
2d7d29d1
Commit
2d7d29d1
authored
7 years ago
by
Niko Ehrenfeuchter
Browse files
Options
Downloads
Patches
Plain Diff
Explain committing and coding conventions
parent
ddc332cc
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
CONTRIBUTING.md
+42
-1
42 additions, 1 deletion
CONTRIBUTING.md
with
42 additions
and
1 deletion
CONTRIBUTING.md
+
42
−
1
View file @
2d7d29d1
...
...
@@ -50,5 +50,46 @@ Refactoring suggestions and / or pull requests are welcome!
configuration file version and of course the required service binaries, DLLs,
etc.
## Making Changes
-
Do
[
atomic commits
][
web_commit
]
.
-
For any change that consists of more than a single commit, create a topic
branch.
-
Check for unnecessary whitespace with
`git diff --check`
before committing.
-
Make sure your commit messages are in a proper format.
-
Use the present tense ("Add feature" not "Added feature").
-
Use the imperative mood ("Change foo to..." not "Changes foo to...").
-
Limit the first line to 72 characters or less.
-
If the commit addresses an issue filed
**on GitHub**
please
**DO NOT**
reference that issue in the commit message (issue tracking is done in the
[
primary repository in the Uni Basel GitLab
][
web_autotx_gitlab
]
).
## Coding Conventions
As mentioned above, the
**C#**
style used throughout the project differs from
the default one suggested by Microsoft, mostly in being much more compact when
using curly brackets - a little bit inspired by the common Python coding
conventions. The formatting rules are stored in the project's
*ReSharper*
settings, so simply use that to do the formatting job.
For the
**PowerShell**
parts there is one major difference about the naming of
(internal) functions, disregarding the common
`Verb-Noun`
convention. In places
where it improves readability of the code, functions may be named different.
Compare e.g.
```
powershell
if
(
ServiceIsRunning
$ServiceName
)
{
Write-Host
"Success"
}
```
vs.
```
powershell
if
(
Check-Service
$ServiceName
)
{
Write-Host
"Success"
}
```
where the former one is literally readable and concise, whereas the latter one
requires those not familiar with the code to go and check what the method
actually does.
[
web_robosharp
]:
https://github.com/tjscience/RoboSharp
[
web_robosharp_fork
]:
https://git.scicore.unibas.ch/vamp/robosharp
\ No newline at end of file
[
web_robosharp_fork
]:
https://git.scicore.unibas.ch/vamp/robosharp
[
web_commit
]:
https://en.wikipedia.org/wiki/Atomic_commit#Atomic_commit_convention
[
web_autotx_gitlab
]:
https://git.scicore.unibas.ch/vamp/auto-tx
\ No newline at end of file
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