Skip to content

Commit

Permalink
Update and rename CONTRIBUTE.md to .github/CONTRIBUTING.md
Browse files Browse the repository at this point in the history
So it shows up on each PR
  • Loading branch information
bartlannoeye committed May 15, 2016
1 parent a7ca3c2 commit 9af5aa9
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions CONTRIBUTE.md → .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
#Contributing to Prism
Welcome! We would love to have you contribute bug fixes or new functionality to Prism.

The best starting point is to enter an Issue [here](https://github.com/PrismLibrary/Prism/issues). We can then have a brief discussion on what you want to do and where it fits with our milestones and goals for the library. As long as it sounds like something we would want to add to Prism, we will give you a thumbs up and ask for a pull request.
The best starting point is to enter an __issue__ [here](https://github.com/PrismLibrary/Prism/issues). We can then have a brief discussion on what you want to do and where it fits with our milestones and goals for the library. As long as it sounds like something we would want to add to Prism, we will give you a thumbs up and ask for a pull request.

When you submit a pull request, there are a few things we would like you to comply with:
When you submit a __pull request__, there are a few things we would like you to comply with:
- New functionality must have accompanying unit tests with "good" code coverage if it is logic code that can be unit tested (i.e. not view stuff touching UI or platform APIs)
- Changes to existing functionality needs to be checked that it does not break any existing unit tests. If it does, then fixes to the unit test may be appropriate, but only if those changes maintain the original intent of the test.
- Some basic coding standard guidelines to start with:
Expand All @@ -13,12 +13,13 @@ When you submit a pull request, there are a few things we would like you to comp
- due consideration for inheritance (i.e. consider carefully whether something should be protected or virtual)
- member variables have leading underscore and are _camelCased
- local variables are camelCased with no prefix
- Types, properties, methods, events are PascalCased
- types, properties, methods, events are PascalCased
- use new C# features (e.g nameof) where possible, but keep the code readable (e.g. don't var everything)

### Contribution License Agreement

You must sign a [.NET Foundation Contribution License Agreement (CLA)](http://cla2.dotnetfoundation.org) before your PR will be merged. This a one-time requirement for projects in the .NET Foundation. You can read more about [Contribution License Agreements (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) on wikipedia.

However, you don't have to do this up-front. You can simply clone, fork, and submit your pull-request as usual.

When your pull-request is created, it is classified by a CLA bot. If the change is trivial, i.e. you just fixed a typo, then the PR is labelled with `cla-not-required`. Otherwise it's classified as `cla-required`. In that case, the system will also tell you how you can sign the CLA. Once you signed a CLA, the current pull-request will be labeled `cla-signed` and all future pull-requests as `cla-already-signed`.
When your pull-request is created, it is classified by a CLA bot. If the change is trivial, i.e. you just fixed a typo, then the PR is labelled with `cla-not-required`. Otherwise it's classified as `cla-required`. In that case, the system will also tell you how you can sign the CLA. Once you signed a CLA, the current pull-request will be labeled `cla-signed` and all future pull-requests as `cla-already-signed`.

0 comments on commit 9af5aa9

Please sign in to comment.