Skip to content

Latest commit

 

History

History
38 lines (27 loc) · 1.78 KB

CONTRIBUTING.md

File metadata and controls

38 lines (27 loc) · 1.78 KB
Raw

How to contribute

This python-package is a first outcome of an interdisciplinary project aimed at understanding the complex interplay between conflict and climate and environment. As such, the presented code and functionalities can only be seen as a first step towards a fully-fledged model. We therefore strongly encourage other users to contribute to this project!

General notes

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct, please follow it in all your interactions with the project, the project owners, and users of the project.

Getting Started

  • Make sure you have a GitHub account.
  • Fork the repository on GitHub.

Making Changes

  • Create a topic branch from where you want to base your work.
    • This is usually the dev branch.
    • Only target release branches if you are certain your fix must be on that branch.
    • To quickly create a topic branch based on master, run git checkout -b fix/dev/my_contribution master. Please avoid working directly on the dev (or master) branch.
  • Make commits of logical and atomic units. Write a good commit message!
  • Make sure you have added the necessary tests for your changes.

Submitting Changes

  • Push your changes to a topic branch in your fork of the repository.
  • Submit a pull request to the repository.
  • The core team looks at pull requests as soon as possible, but no maximum waiting time can be given here.
  • After feedback has been given we expect responses within two weeks. After two weeks we may close the pull request if it isn't showing any activity.