To make it clear exactly how outside contributors should provide their contributions to the project, a file should be created at the root of the repository. Once such a file exists, GitHub will present it to users creating new pull requests, issues, etc. in the repository. Here's an example of how such a file can look like:

# How to contribute

To contribute to the PayEx Development Guidelines, there's just a few things you need to know.

## Getting Started

* Read and make sure you agree with the [Code of Conduct][coc].
* Make sure you have a [GitHub account][github].
* Then, you have three options:
   1. Submit a ticket for your issue, assuming one does not already exist.
       * Clearly describe the issue including steps to reproduce when it is a bug.
       * Make sure you fill in the earliest version that you know has the issue.
   2. [Directly edit the file][edit] you want to change on GitHub.
   3. [Fork the repository on GitHub][forking].

If you choose option 3 (forking the repository), then please read on.

## Making Changes

* Create a new [branch][branching] from where you want to base your work.
 * This is usually the `master` branch.
 * Please avoid working directly on the `master` branch.
* Make [commits][commit] of logical units in the new branch.
* Check for unnecessary whitespace with `git diff --check` before committing.
* Make sure your [commit messages][commit-practice] are well written and in the proper format.
* [Push][push] the branch to your [forked repository ("remote")][remote].
* Submit a [pull request][pull-request] for the pushed branch.

Created by Asbjørn Ulsberg on 2018/11/30 13:13