Adding README, CONTRIBUTING, LICENSE

We plan to release this code under the MIT license so might as well get
the right things in place early.
This commit is contained in:
Haacked
2013-01-09 13:24:06 -08:00
parent 8dc81baf07
commit dafab8af04
3 changed files with 139 additions and 0 deletions

51
CONTRIBUTING.md Normal file
View File

@@ -0,0 +1,51 @@
# How to Contribute
We love Pull Requests! Your contributions help make Nocto great.
## Getting Started
So you want to contribute to Nocto. Great! Contributions take many forms from
submitting issues, writing docs, to making code changes. We welcome it all.
But first things first...
* Make sure you have a [GitHub account](https://github.com/signup/free)
* 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.
* Fork the repository on GitHub by clicking on the "Clone in Windows" button or
run the following command in a git shell.
```
git clone git@github.com:github/Nocto.git
```
* Make sure the project builds and all tests pass on your machine by running
the `build.cmd` script (this calls a PowerShell script, `Build-Solution.ps1`).
## Making Changes
* Create a topic branch off master (don't work directly on master).
* Make commits of logical units.
* Provide descriptive commit messages in the proper format (GitHub for Windows
helps get the format correct).
* Make sure you have added the necessary tests for your changes.
* Run _all_ the tests to assure nothing else was accidentally broken.
## Submitting Changes
* Push your changes to a topic branch in your fork of the repository.
* Submit a pull request. Note what issue/issues your patch fixes.
Some things that will increase the chance that your pull request is accepted.
* Follow existing code conventions. Most of what we do follows standard .NET
conventions except in a few places. We include a ReSharper team settings file.
* Include unit tests that would otherwise fail without your code, but pass with
it.
* Update the documentation, the surrounding one, examples elsewhere, guides,
whatever is affected by your contribution
# Additional Resources
* [General GitHub documentation](http://help.github.com/)
* [GitHub pull request documentation](http://help.github.com/send-pull-requests/)

19
LICENSE.txt Normal file
View File

@@ -0,0 +1,19 @@
Copyright (c) 2012 GitHub, Inc.
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

69
README.md Normal file
View File

@@ -0,0 +1,69 @@
# Nocto - GitHub API Client Library for .NET
Nocto is a client library targeting .NET 4.0 and above that provides an easy
way to interact with the [GitHub API](http://developer.github.com/v3/).
## Usage examples
Get public info on a specific user.
```
var github = new GitHubClient();
var user = await github.User.Get("half-ogre");
Console.WriteLine(user.Followers + " folks love the half ogre!");
```
## Getting Started
Nocto is available on NuGet.
```
Install-Package Nocto
```
## Build
Nocto is a single assembly designed to be easy to deploy anywhere. If you prefer
to compile it yourself, youll need:
* Visual Studio 2012
* PowerShell 2.0 or greater. _For our build scripts_.
To clone it locally click the "Clone in Windows" button above or run the
following git commands.
```
git clone git@github.com:github/Nocto.git
cd Nocto
.\build.cmd
```
## Problems?
Nocto is 100% certified to be bug free. If you find an issue with our
certification, please visit the [issue tracker](https://github.com/github/Nocto/issues)
and report the issue.
Please be kind and search to see if the issue is already logged before creating
a new one. If you're pressed for time, log it anyways.
When creating an issue, clearly explain
* What you were trying to do.
* What you expected to happen.
* What actually happened.
* Steps to reproduce the problem.
Also include any other information you think is relevant to reproduce the
problem.
## Contribute
Visit the [Contributor Guidelines](https://github.com/github/Nocto/blob/master/CONTRIBUTING.md)
for more details.
## Copyright and License
Copyright 2013 GitHub, Inc.
Licensed under the [MIT License](https://github.com/github/Nocto/blob/master/LICENSE.txt)