Skip to content

Commit

Permalink
Added some getting started lines to the Changelog. (matomo-org#160)
Browse files Browse the repository at this point in the history
  • Loading branch information
brototyp authored Jun 26, 2017
1 parent 046965d commit 6dcb8bd
Showing 1 changed file with 21 additions and 5 deletions.
26 changes: 21 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,6 @@

Welcome! We are very happy to have you here. There are always to many things to do and not enough volunteers to help. So please join! This document collect things we need help with and act as a guideline.

## Testing

We have a small set of [Quick](https://github.com/Quick/Quick) and [Nimble](https://github.com/Quick/Nimble) specs and we are always open for more.

## Reporting bugs

Did you find a bug? Bummer! Please help us find the reason and fix them.
Expand All @@ -26,4 +22,24 @@ You are always welcome to add your thoughts to an existing [issue in discussion]

When contributing to this repository, please first discuss the change you wish to make via an issue before making a change.

If you implemeted a change please send a [Pull Request](https://github.com/piwik/piwik-sdk-ios/compare?expand=1) with a clear list of what you have done. Try to only tackle one thing a time. This will lead to smaller pull requests that are easier to review.
If you implemeted a change please send a [Pull Request](https://github.com/piwik/piwik-sdk-ios/compare?expand=1) with a clear list of what you have done. Try to only tackle one thing a time. This will lead to smaller pull requests that are easier to review.

## Contributing Code

You want to contribute code? Awesome. Here are some tips that should get you started.

1. Check out the repository
2. Install the Cocoapods by running `pod install` from the checked out folder
3. Open the Workspace in Xcode

### Adding code to the SDK

In the Workspace you will find the *PiwikTracker* Project. Inside of it there is a folder for the SDK code and one for the Tests. Tests can be run from the *PiwikTracker* scheme.

### Adding example code

All the example code can be found in the Workspace, in the *Examples* folder. There is a scheme for every example application. When changing the SDK itself, it might be necessary to run a `pod update` to install all those changes in the Example applications.

### Testing

We have a small set of [Quick](https://github.com/Quick/Quick) and [Nimble](https://github.com/Quick/Nimble) specs and we are always open for more.

0 comments on commit 6dcb8bd

Please sign in to comment.