Skip to content

Latest commit

 

History

History
62 lines (50 loc) · 1.92 KB

CONTRIBUTING.md

File metadata and controls

62 lines (50 loc) · 1.92 KB

Contributions

Commits

Please have a look at the commit history for examples.

first line describes in present tense what the commit does

Problem: If it is not described in the first line
Solution: If it is not described in the first line

- related/fixes/contributes to link to issue
- changes in this commit i.e. bug fix/refactoring

Commits referencing issues will turn up in the release history.

Pull Requests

You can create a pull request in the following way.

First time contribution

  1. fork the repository
  2. Your fork is present at https://github.com/YOURUSERNAME/mundraub-android. Replace YOURUSERNAME with your user name in the following.
  3. Clone the fork 
    git clone https://github.com/YOURUSERNAME/mundraub-android.git
    You can also use ssh with GitHub, if you have generated a key. 
    git clone [email protected]:YOURUSERNAME/mundraub-android.git
  4. Create a new branch for the contribution. Replace BRANCHNAME with a suitable name without spaces in the following. 
    git checkout -b BRANCHNAME
  5. Do your changes.
  6. Create a commit using the commit format described above. 
    git commit -m"...
...
..."
  7. Push the commit. 
    git push -u origin BRANCHNAME
  8. Create a pull request. Replace YOURUSERNAME and BRANCHNAME in this url https://github.com/niccokunzmann/mundraub-android/compare/master...YOURUSERNAME:BRANCHNAME or configure it with compare across forks: https://github.com/niccokunzmann/mundraub-android/compare
  9. Describe the pull request. Reference the issue.
  10. Create the pull request. We will review it!