Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
O
ogs
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Requirements
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Test cases
Artifacts
Deploy
Package registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Code review analytics
Issue analytics
Insights
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
Mojtaba Abdolkhani
ogs
Commits
f9977821
Verified
Commit
f9977821
authored
4 years ago
by
Lars Bilke
Browse files
Options
Downloads
Patches
Plain Diff
Adapted Contributing.md
parent
b98dc786
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
+6
-42
6 additions, 42 deletions
CONTRIBUTING.md
with
6 additions
and
42 deletions
CONTRIBUTING.md
+
6
−
42
View file @
f9977821
# How to contribute
# How to contribute
Please refer to our
[
Developer Guide
](
https://opengeosys.org/docs/devguide
)
for
instructions on contributing to OpenGeoSys:
-
The
[
Getting Started
](
https://www.opengeosys.org/docs/devguide/getting-started/introduction/
)
-section
## Getting Started
guides you through setting up a development environment.
-
In
[
Development Workflows
](
https://www.opengeosys.org/docs/devguide/development-workflows/branching-model/
)
*
Make sure you have a
[
GitHub account
](
https://github.com/signup/free
)
you learn about our development model.
*
Fork the repository on GitHub
## Making Changes
*
Create a topic branch from where you want to base your work.
*
This is usually the master branch.
*
Only target other branches if you are certain your fix must be on that
branch.
*
To quickly create a topic branch based on master;
`git branch
my_topic_branch master`
then checkout the new branch with
`git
checkout my_topic_branch`
. Please avoid working directly on the
`master`
branch.
*
Make commits of logical units.
*
Make sure your code conforms to the
[
styleguide
][
styleguide
]
.
*
Check for unnecessary whitespace with
`git diff --check`
before committing.
*
Make sure your commit messages are in the proper format.
````
One sentence summary.
Detailed description of the commit ...
....
````
*
TODO: Test your changes
## Submitting Changes
*
Push your changes to a topic branch in your fork of the repository.
*
Submit a pull request to the main repository.
# Additional Resources
*
[
General GitHub documentation
](
http://help.github.com/
)
*
[
GitHub pull request documentation
](
http://help.github.com/send-pull-requests/
)
*
[
OGS Styleguide
][
styleguide
]
[
styleguide
]:
http://ufz.github.com/styleguide/cppguide.xml
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