Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
205 commits
Select commit Hold shift + click to select a range
0a882ce
introduce Contributor Covenant template
shiftkey Mar 17, 2016
e89e7f9
add mention in README
shiftkey May 11, 2016
fe1ab36
Merge pull request #1444 from octokit/release
shiftkey Sep 1, 2016
369adb2
rewrite LINQPad samples functionality in F#. fixes #1081
mderriey Sep 1, 2016
8d87ddb
add FSharp.Data NuGet package installation to build.sh
mderriey Sep 1, 2016
722207f
it looks like file names are case sensitive when using mono
mderriey Sep 1, 2016
8c0a4fd
VS Code wants to remove trailing whitespace
mderriey Sep 2, 2016
66095c2
output the name of the original LINQPad sample when running them
mderriey Sep 2, 2016
4d20573
remove C# LINQPad samples checks test
mderriey Sep 2, 2016
a63234c
try to be consistent in the F# code style
mderriey Sep 3, 2016
6042a12
Remove previously obsoleted UsersClient.Keys property
ryangribble Sep 6, 2016
9d22ed4
Remove previously obsoleted IConnection.GetRedirect and IApiConnectio…
ryangribble Sep 6, 2016
9411302
Remove previously obsoleted IssueTypeQualifier.PR enum value
ryangribble Sep 6, 2016
f36fe23
Remove previously obsoleted mis-spelled Language enum values
ryangribble Sep 6, 2016
f3d7429
Remove previously obsoleted ObservableMiscellaneousClient ctor
ryangribble Sep 6, 2016
6f18461
Remove previously obsoleted CompareResult.MergedBaseCommit property
ryangribble Sep 6, 2016
cf048d7
Remove previously obsoleted ApiUrls.Blob method
ryangribble Sep 6, 2016
1e247a8
Merge pull request #1456 from mderriey/rewrite-linqpad-samples-checks…
shiftkey Sep 6, 2016
5883360
Merge pull request #1458 from TattsGroup/spring-cleaning
shiftkey Sep 7, 2016
3bde78b
changed C# -> CSharp
alexander-efremov Sep 12, 2016
cbc102a
adding .NET Core solution and projects
mderriey Sep 12, 2016
091f9bd
update FAKE to get dotnet CLI support
mderriey Sep 12, 2016
3eb2729
add .NET Core targets in FAKE build script
mderriey Sep 12, 2016
341acd2
first try at modifying the AppVeyor and Travis files
mderriey Sep 12, 2016
85f8a4c
try something else for Travis
mderriey Sep 12, 2016
297fe2f
add mono. of course we need it to install NuGet dependencies
mderriey Sep 12, 2016
eb57ebd
bring back original build tasks
mderriey Sep 14, 2016
b3c1c80
use mono 4.2.3 as latest successful builds show this version was used
mderriey Sep 14, 2016
9c95477
remove specific `osx_image`
mderriey Sep 14, 2016
9e958bf
Make Repository Id a long, it's going to grow...
shana Jun 23, 2016
14ba023
Merge pull request #1463 from dampir/fix1459
shiftkey Sep 15, 2016
893c184
add other specific `osx_image`
mderriey Sep 15, 2016
7678ba8
try to work around Homebrew refusing to link OpenSSL
mderriey Sep 15, 2016
26b15dd
and again I try
mderriey Sep 15, 2016
2de3c73
yet another try - probably not the last
mderriey Sep 15, 2016
766d3e2
brincg back linux since last build passed
mderriey Sep 15, 2016
c9b2c12
Merge pull request #1462 from mderriey/add-simple-dot-net-core-project
shiftkey Sep 15, 2016
6a21ce5
Merge pull request #1445 from shana/change-int-to-long
shiftkey Sep 16, 2016
93ae832
[WIP] Protected branches updates - granular methods (#1443)
martinscholz83 Sep 20, 2016
693cc29
Code to test URL for an enterprise instance. (#1404)
haacked Sep 21, 2016
a57fb12
[WIP] Add repository traffic preview (#1457)
martinscholz83 Sep 28, 2016
2f6d6be
Add new fields to Repository object
ryangribble Sep 28, 2016
60537e1
Update RepositoriesClient.Get() method to specify preview accepts hea…
ryangribble Sep 28, 2016
d03f344
Add integration test to assert new fields are returned (but they aren…
ryangribble Sep 28, 2016
8dcb1db
just marking up some code
shiftkey Sep 29, 2016
37048d1
Add MergeMethod property to PR merge request
ryangribble Sep 29, 2016
4a67f19
Add some xmldoc for the PullRequestMergeMethod enum and values
ryangribble Sep 29, 2016
e893895
Update git-database.md
abdulrehmangill Sep 30, 2016
e31ac86
Add new fields to RepositoryUpdate request and update RepositoriesCli…
ryangribble Oct 1, 2016
d1b0ff4
add integration tests for Update repository
ryangribble Oct 1, 2016
cce91c3
Merge pull request #1482 from abdulrehmangill/patch-1
shiftkey Oct 2, 2016
01c6614
Merge pull request #1479 from TattsGroup/pr-merge-method
shiftkey Oct 3, 2016
3409ae1
Add new ctor to PublicRepositoryRequest taking "since" parameter as a…
ryangribble Oct 3, 2016
82dfabe
Fixing Async Deadlock
Oct 3, 2016
0ff6f08
Merge pull request #1485 from TattsGroup/repositoryid-since
shiftkey Oct 4, 2016
38f8da2
Merge pull request #1486 from zzzprojects/master
shiftkey Oct 4, 2016
cf4c78c
Add new fields to NewRepository request and update RepositoriesClient…
ryangribble Oct 1, 2016
de3e809
Revert merge method changes for New Repository as it is not supported…
ryangribble Oct 4, 2016
feb7561
Merge pull request #1477 from TattsGroup/repo-merge-options
shiftkey Oct 4, 2016
635f42b
added release notes
shiftkey Oct 3, 2016
b53486e
tweak release notes
shiftkey Oct 3, 2016
d3467e9
edits to release notes
shiftkey Oct 4, 2016
12f5627
updating tests as the example repository changed
shiftkey Oct 4, 2016
0f90d20
muting failing tests
shiftkey Oct 4, 2016
d79367f
updated release notes
shiftkey Oct 4, 2016
1431306
it is now today, not yesterday
shiftkey Oct 7, 2016
f928940
corrected a couple of tests
shiftkey Oct 7, 2016
4bd3a44
Merge pull request #1484 from octokit/release
shiftkey Oct 7, 2016
4be25ba
Add missing `SecurityCritical` attribute
M-Zuber Oct 13, 2016
10d2632
Missing Milestone fields (#1489)
StanleyGoldman Oct 13, 2016
80615e5
Correcting return type in ObservableEventsClient
StanleyGoldman Oct 9, 2016
7fb35ca
Fixing unit tests
StanleyGoldman Oct 16, 2016
754e937
Correcting convention unit tests
StanleyGoldman Oct 16, 2016
9265350
Additional test fixes
StanleyGoldman Oct 16, 2016
ea64789
Merge pull request #1493 from M-Zuber/fix-1471
shiftkey Oct 16, 2016
e2af971
Merge pull request #1490 from StanleyGoldman/fixes/issue-events
shiftkey Oct 19, 2016
e60d727
[UserUpdate] - Fix typo.
ivandrofly Oct 29, 2016
091248b
Merge pull request #1498 from ivandrofly/patch-typo
shiftkey Oct 30, 2016
97dee1e
Deployments tidy up [WIP] (#1497)
ivandrofly Nov 21, 2016
88e5342
Allow base64 content for create/update file (#1488)
Nov 21, 2016
195de68
Added a get all organizations method (#1469)
malamour-work Nov 21, 2016
155073b
[WIP] Rename Comment to ReviewComment (#1520)
bmeverett Dec 31, 2016
49c2d52
Add ApiInfo Rate limiting description to Getting Started (#1524)
SeanKilleen Jan 1, 2017
cf0eddd
Fix IssueCommentClient #1500 (#1501)
pjc0247 Jan 7, 2017
3a1070f
Add docs snippet for label coloring (#1530)
SeanKilleen Jan 9, 2017
49156a0
changed the email address
shiftkey Jan 9, 2017
38f0826
Merge pull request #1197 from octokit/shiftkey-code-of-conduct
haacked Jan 9, 2017
4e16d93
Modified code comment for RepositoryContentInfo.Sha (#1534)
JohnGoldsmith Jan 11, 2017
b4fad9b
Add multiple assignees to issues (#1339)
martinscholz83 Jan 11, 2017
4cec3a6
Introduce AbuseException (#1528)
SeanKilleen Jan 11, 2017
eeb98c7
Add Missing Event Types (#1536)
lynnfaraday Jan 13, 2017
fcee797
Add Id for PullRequest.cs (#1537)
YunLi1988 Jan 14, 2017
620b1b9
Add missing fields to Repository class - HasPages, SubscribersCount, …
ryangribble Jan 15, 2017
01a2d97
Update ApiErrorMessageSafe to return null for empty and whitespace st…
SeanKilleen Jan 16, 2017
aa80eaa
Add "Bot" AccountType, was causing a deserialization exception when r…
ryangribble Jan 16, 2017
3c81893
Release v0.24 - A Sight For Sore Eyes (#1539)
ryangribble Jan 17, 2017
13d5dab
Port to .NET Core (#1503)
mderriey Jan 21, 2017
3369a4a
Add a build task to validate LINQPad samples (#1551)
mderriey Jan 28, 2017
938149f
Add a code formatting task to CAKE (#1550)
mderriey Jan 28, 2017
6b8dde1
Remove unneeded files for .NET Core (#1549)
mderriey Jan 28, 2017
8431787
add GitVersion configuration file (#1555)
mderriey Jan 29, 2017
4ff2604
change appveyor config - public projects can no longer use account fe…
ryangribble Mar 5, 2017
16f7d86
React to change in the way the RepositoryTraffic API communicates tim…
mderriey Mar 5, 2017
a952eb8
Add merge_commit_sha to PullRequest model (#1562)
alexperovich Mar 11, 2017
bf6b6e8
fix .sln file for linux (#1556)
ArsenShnurkov Mar 11, 2017
c89a29f
Update existing tests to use Octokit PR 1503 as it has some of the ne…
ryangribble Mar 11, 2017
7084a39
Write a timeline test that processes the most recent 20 closed PRs an…
ryangribble Mar 11, 2017
3a1e4b8
Fix failing tests by adding 2 new (undocumented) EventInfoState values
ryangribble Mar 11, 2017
3c8e5c6
Changed test to use microsoft/vscode
ryangribble Mar 11, 2017
31bfc5c
Found another new event type!
ryangribble Mar 11, 2017
a936184
response enums can be camelcase as underscores are removed in the des…
ryangribble Mar 15, 2017
1fb9a40
delete the parameterless constructor of RepositoryUpdate
eriawan Mar 20, 2017
32aa4e7
Supply the call to ctor with anyreponame string parameter for unit test
eriawan Mar 20, 2017
f020170
Since we'have removed the default constructor of RepositoryUpdate, th…
eriawan Mar 20, 2017
332b521
Retain the rest of property initializers
eriawan Mar 20, 2017
d8c549c
update the code to instantiate RepositoryUpdate with reponame param a…
eriawan Mar 20, 2017
ac49d2a
Migrate dotnetcore to vs2017 tooling (#1567)
ryangribble Mar 30, 2017
8a1aa4a
Merge pull request #1569 from eriawan/remove_obsoleted_RepositoryUpda…
shiftkey Mar 31, 2017
21a2c57
[StringExtensions] - Display correct variable name when throwing. (#1…
ivandrofly Apr 2, 2017
79dc11d
Update release code sample to client.Repository.Release
ryangribble Apr 2, 2017
6c379fe
Merge pull request #1563 from TattsGroup/fix-enum
shiftkey Apr 2, 2017
dba2b7b
Merge pull request #1577 from octokit/release-doc
shiftkey Apr 3, 2017
96df1a7
Add sourcelink support (#1574)
ryangribble Apr 3, 2017
596e51d
Surface exceptions in RepoCollaboratorsClient.Add method (#1576)
joensindholt Apr 3, 2017
6be608b
Merge remote-tracking branch 'upstream/master' into dotnetcore
ryangribble Apr 4, 2017
11bbb2d
missed solution file update
ryangribble Apr 11, 2017
f6154da
bugfix - PUT should have a payload for Mark as Read (#1579)
shiftkey Apr 13, 2017
0a9a31d
Cloning ApiInfo object should work when some fields are null (#1580)
ryangribble Apr 19, 2017
ad49dfb
Remove Rx-Main dependency from samples
Apr 26, 2017
d3aea72
Merge pull request #1593 from NickCraver/master
shiftkey Apr 27, 2017
eb10aae
Adding RemovedFromProject and other missing EventInfoState types. (#1…
lynnfaraday Apr 29, 2017
73feece
Change response models 'Url' properties from `Uri` to `string` (#1585)
mderriey Apr 30, 2017
9c80b00
Merge master into dotnetcore (#1599)
mderriey May 2, 2017
977148c
Merge branch 'master' into dotnetcore
ryangribble May 2, 2017
ffdf688
Final tidyups for dotnetcore (#1600)
ryangribble May 4, 2017
58ba2ec
Add BranchProtection.EnforceAdmins object (#1598)
M-Zuber May 4, 2017
351318f
Merge remote-tracking branch 'origin/master' into dotnetcore
ryangribble May 4, 2017
5f4a8d3
Merge pull request #1581 from octokit/dotnetcore
ryangribble May 4, 2017
30e3ec8
[doc/issues]fix typo
tnaoto May 7, 2017
1359367
Merge pull request #1602 from tnaoto/fix_doc
shiftkey May 7, 2017
97ae3cb
Add Pull Request Review Request API. (#1588)
gdziadkiewicz May 14, 2017
afb81b7
ReleaseUpdate should be NewRelease in create release section
watsonlu Jun 7, 2017
d0ea6ae
Merge pull request #1611 from watsonlu/newreleasefix
shiftkey Jun 7, 2017
8877eea
Added syntax highlighting to docs/getting-started.md (#1619)
theel0ja Jun 25, 2017
5ee4d64
Add StringEnum to handle unknown enum values returned from API (#1595)
khellang Jun 25, 2017
98dfd77
Remove the obsolete branch protection methods and classes as they are…
ryangribble Jun 26, 2017
b7ad64d
Remove obsolete members (#1622)
ryangribble Jun 26, 2017
92cc3a5
Improve DocPlagiarizer.README.md readability (#1629)
jozefizso Jul 21, 2017
fc5bc94
Fixes #1621 NewRepositoryWebHook no longer creates new instance... (#…
ctolkien Jul 22, 2017
329ef96
[WIP] Add new Project API Preview (#1480)
martinscholz83 Jul 22, 2017
db74c3b
Fix async tests (#1631)
ryangribble Jul 22, 2017
cda714b
Organization membership preview API changes - Review user permission …
hnrkndrssn Jul 29, 2017
b01f342
Merge tag 'v0.24.0' into upgrade-to-0.24.0
grokys Aug 1, 2017
1d1ca0a
Add client for organization outside collaborators (#1639)
hnrkndrssn Aug 7, 2017
4869fd5
Fix broken JSON deserialization in .NET 4.5 (#1647)
mderriey Aug 7, 2017
635b42d
Fix Uri.ApplyParameters() to handle relative Uri's that have existing…
ryangribble Aug 8, 2017
b0ff506
Implement pagination on Organization Outside Collaborators Client Get…
ryangribble Aug 9, 2017
7c17021
List pending organization / team invitations (#1640)
hnrkndrssn Aug 14, 2017
ff9521c
Implement Review API for Pull Requests (#1648)
hartra344 Aug 16, 2017
7114bcb
General updates (#1653)
ryangribble Aug 16, 2017
951ca4f
Fix RepositoryCommitsClient.GetSha1 API call after preview period end…
ryangribble Aug 19, 2017
5e89232
Release v0.25 - She'll be Comin' Round the Mountain (#1656)
ryangribble Aug 23, 2017
dd2d977
Wop optimized this repository (#1657)
devedse Aug 24, 2017
a2b48a6
ProtectedBranches API changes for Required Review Enforcement (#1523)
M-Zuber Aug 30, 2017
f96d75f
Release v0.26 - In the Nick of Time (#1658)
ryangribble Aug 31, 2017
1e474f8
Enable pagination convention tests (#1659)
ryangribble Sep 3, 2017
366ac26
Fix assembly versioning/properties and handle platform exception (#1660)
ryangribble Sep 3, 2017
0f285ae
Add missing fields to Team response, and NewTeam/UpdateTeam requests …
ryangribble Sep 11, 2017
90a18de
Enable generation of XML doc files (#1674)
mderriey Sep 11, 2017
2b28aa5
Added Organization to code search (#1671) (#1672)
sepharg Sep 11, 2017
f9ffce8
Provide constructors for EnforceAdmins class to allow mocking (#1679)
ryangribble Sep 12, 2017
ac5279c
Fix forks qualifier in repo search and add tests (#1680)
ryangribble Sep 13, 2017
da0c7a5
Implement Team Membership changes (#1670)
ryangribble Sep 26, 2017
e93646c
Implement Nested Teams preview API changes (#1682)
ryangribble Oct 4, 2017
0f0a0dc
Release v0.27 - On a Roll (#1687)
ryangribble Oct 7, 2017
2495487
Fixed code formatting (#1691)
prashantvc Oct 23, 2017
c8ff57b
Add possibility to configure GitHubClient timeout (#963) (#1693)
pmiossec Oct 29, 2017
73679d0
Remove extra space before close ticks. (#1699)
scovetta Oct 29, 2017
3b26177
Prevent overflow exceptions when status id > int.Max (#1703)
kzu Nov 6, 2017
ed1feb6
Release v0.28 - Get to the Chopper!!! (#1709)
ryangribble Nov 6, 2017
b6e80e8
Change warning color to yellow. (#1714)
gdziadkiewicz Nov 13, 2017
c45175b
Add Pull Request Comment "In Reply To" Field (#1715)
thedillonb Nov 15, 2017
eb2b9ea
Support running in aws lambda by fixing netcoreapp1.1 vs netcoreapp1.…
ryangribble Nov 15, 2017
e9c7e02
Added UpdatedAt property to Milestone. (#1722)
shaggygi Nov 30, 2017
e1b6434
Add pagination support to ReferencesClient. (#1694)
gdziadkiewicz Dec 1, 2017
01d16b7
Add pagination support to repository invitation. (#1692)
gdziadkiewicz Dec 3, 2017
bc7830f
Fix OAuthClient to work correctly with GitHub Enterprise instances (#…
ryangribble Jan 4, 2018
9a29aa4
Add support for StatusEventPayload (#1732)
itaibh Jan 9, 2018
da3bbe3
Added support for DateTime serialized as FileTime (#1735)
itaibh Jan 18, 2018
a2f6650
Add a new column named PullRequestReviewId to PullRequestReviewCommen…
mirsaeedi Jan 18, 2018
270356b
Fixes #1586 - Repository license API (#1630)
jozefizso Jan 19, 2018
f1b9674
Improve Rate Limits' Documentation (#1742)
mirsaeedi Jan 22, 2018
11e1c30
add NET Core (#1744)
ShalokShalom Jan 22, 2018
81635c6
Fixes #1750, changing description of productInformation param for cla…
IAmHughes Jan 31, 2018
bf06885
Refactors GitHubSerializerStrategy to be thread-safe (#1683) (#1748)
daveaglick Jan 31, 2018
2340f8d
fix AccountType enum attributes to match the sentence case used in th…
ryangribble Feb 13, 2018
b35b60f
Add TLS1.2 to enabled security protocols (.NET Framework 4.5 only) (#…
ryangribble Feb 13, 2018
41b4059
Deserializer should handle nullable StringEnum<T> (#1760)
ryangribble Feb 16, 2018
aa9e0de
Implements PullRequest.MergeableState field (#1764)
ryangribble Feb 18, 2018
b797ed7
Asapferg/user email visibility (#1757)
Feb 18, 2018
c4774ff
Release v0.29 - This Looks Serious (TLS) (#1765)
ryangribble Feb 18, 2018
629f628
Merge tag 'v0.29.0' into upgrade-to-0.29.0
grokys Mar 6, 2018
92699ac
Updated version in SolutionInfo.cs.
grokys Mar 6, 2018
5c55850
Use C#6 in Octokit.Reactive
grokys Mar 6, 2018
d807d06
Added AssemblyInformationalVersionAttribute.
grokys Mar 6, 2018
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
21 changes: 16 additions & 5 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -72,10 +72,6 @@ Generated_Code #added for RIA/Silverlight projects
nunit-*.xml
*.userprefs
packaging/
tools/FAKE.Core
tools/SourceLink.Fake
tools/xunit.runner.console
tools/Octokit.CodeFormatter
*.ncrunch*
*.GhostDoc.xml

Expand All @@ -90,4 +86,19 @@ pingme.txt
docs/_build

# it's 2015, no need to keep this around when migrating projects
Backup/
Backup/

# .NET Core
*.lock.json

# VSCode
**/.vscode/*
!**/.vscode/settings.json
!**/.vscode/tasks.json
!**/.vscode/launch.json

# CAKE
.dotnet/*
tools/*
!tools/gitversion_wrapper.sh
!tools/LINQPad
29 changes: 17 additions & 12 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,14 +1,19 @@
language: csharp
mono:
- 4.2.3

sudo: false # use the new container-based Travis infrastructure
os:
- osx
- linux
install:
- nuget restore Octokit-Mono.sln
script:
- mono tools/nuget/NuGet.exe restore Octokit-Mono.sln
- ./build.sh BuildMono
- ./build.sh
matrix:
include:
- os: linux
dist: trusty
sudo: required
dotnet: 1.0.4
- os: osx
osx_image: xcode8
dotnet: 1.0.4

before_script:
- if test "$TRAVIS_OS_NAME" == "osx"; then export FrameworkPathOverride=/Library/Frameworks/Mono.framework/Versions/Current/lib/mono/4.5/; else export FrameworkPathOverride=/usr/lib/mono/4.5/; fi

script:
- git fetch --unshallow --tags
- dotnet --info
- ./build.sh --linksources=true
74 changes: 74 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, gender identity and expression, level of experience,
nationality, personal appearance, race, religion, or sexual identity and
orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at [[email protected]](mailto:[email protected]). All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at [http://contributor-covenant.org/version/1/4][version]

[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/
58 changes: 39 additions & 19 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ easiest way to do this. You can then clone down your fork instead:

`git clone https://github.com/MY-USERNAME-HERE/Octokit.net.git Octokit`

After doing that, run the `.\build` script at the root of the repository
After doing that, run the `.\build.ps1` or `./build.sh` script at the root of the repository
to ensure everything builds and the tests pass.

## How can I get involved?
Expand Down Expand Up @@ -56,23 +56,31 @@ potential conflicts that may occur in the future.
If you make focused commits (instead of one monolithic commit) and have descriptive
commit messages, this will help speed up the review process.

### Adding New files
At any time you can build the project with

To ensure new files are available in the various projects, we have a helper script
to synchronize these changes across all the projects in the solution.
`.\build.ps1 -Target Build`
or
`./build.sh --target=build`

If you need to create new files:
this will also run code analysis rules.

- add the file to the main `Octokit` project
- build the project (to ensure the `csproj` change is saved)
- run this command: `.\build FixProjects`
### Running builds cross platform

At any time you can build the project with `.\build BuildApp` - this will also
run FxCop analysis.
Octokit.net uses a CAKE build script and can be built on multiple platforms.

To install dependencies and run the CAKE build script use the following wrapper scripts and parameter syntax:

- Windows (Powershell)

`.\build.ps1 -Target <target> -Configuration Release -LinkSources [Additional Parameters]`

- Linux/OSX (bash)

`./build.sh --target=<target> --configuration==Release --linksources=true [Additional Parameters]`

### Running Tests

Octokit.net also has a suite of tests which you can run to ensure existing
Octokit.net has a suite of tests which you can run to ensure existing
behaviour is not affected. If you're adding new features, please add some
tests alongside so the maintainers can sleep at night, knowing their
safety blanket is nice and green!
Expand All @@ -81,13 +89,21 @@ The test suite is arranged into fast and slow tests.

#### Fast Tests

**Unit Tests:** `.\build UnitTests`
**Unit Tests:**

`.\build.ps1 -Target UnitTests` or `./build.sh --target=UnitTests`

Alternatively, you can run the `Octokit.Tests` assembly in the Visual Studio test runner.

These tests verify specific behaviour while being isolated from the rest of the
library. If you are not familiar with unit testing, have a look at the existing
examples - they should be easy to apply to your work.

**Convention Tests:** `.\build ConventionTests`
**Convention Tests:**

`.\build.ps1 -Target ConventionTests` or `./build.sh --target=ConventionTests`

Alternatively, you can run the `Octokit.Tests.Conventions` assembly in the Visual Studio test runner.

These tests verify conventions and structure across the entire codebase -
ensuring everything is consistent and predictable. When writing new features,
Expand All @@ -108,17 +124,21 @@ variables:

`.\script\configure-integration-tests.ps1`

NOTE: On Linux/OSX the environment variables currently need to be configured manually.

After running this, ensure any existing instances of Visual Studio are restarted
so they pick up the new environment variables are detected.

With these variables set, you can run the integration tests locally using
`.\build IntegrationTests` or by running the `Octokit.Tests.Integration`
assembly in the Visual Studio test runner.

**Note:** as the integration tests rely on using the actual GitHub API, you may
encounter issues if running the tests too frequently. Please use a test account
so that you're not impacted in the unlikely scenario of your account being
flagged as a spammer.
`.\build.ps1 -Target IntegrationTests` or `./build.sh --target=IntegrationTests`

Alternatively, you can run the `Octokit.Tests.Integration` assembly in the Visual Studio test runner.

**Note:** as the integration tests rely on using the actual GitHub API, you will encounter
API rate limit/abuse detection issues if running the tests too frequently. Please use a test account
so that your main account is not impacted in the event that the tests trigger the GitHub abuse
detection mechanism.

### Testing Documentation

Expand Down
11 changes: 11 additions & 0 deletions GitVersion.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
branches:
master:
mode: ContinuousDeployment
increment: Minor
tag: beta
dotnetcore:
mode: ContinuousDeployment
increment: Minor
tag: alpha
ignore:
sha: []
2 changes: 1 addition & 1 deletion LICENSE.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright (c) 2012 GitHub, Inc.
Copyright (c) 2017 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
Expand Down
59 changes: 0 additions & 59 deletions Octokit-Mono.sln

This file was deleted.

Loading