From f9977821c42287def45fdb4784374b5c35ed1dbd Mon Sep 17 00:00:00 2001 From: Lars Bilke <lars.bilke@ufz.de> Date: Thu, 18 Jun 2020 20:11:20 +0200 Subject: [PATCH] Adapted Contributing.md --- CONTRIBUTING.md | 48 ++++++------------------------------------------ 1 file changed, 6 insertions(+), 42 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9e14f508668..9b6095036d2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,45 +1,9 @@ # How to contribute +Please refer to our [Developer Guide](https://opengeosys.org/docs/devguide) for +instructions on contributing to OpenGeoSys: - -## Getting Started - -* Make sure you have a [GitHub account](https://github.com/signup/free) -* 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 +- The [Getting Started](https://www.opengeosys.org/docs/devguide/getting-started/introduction/)-section + guides you through setting up a development environment. +- In [Development Workflows](https://www.opengeosys.org/docs/devguide/development-workflows/branching-model/) + you learn about our development model. -- GitLab