Comments (5)
Hey @sawilde. Do you see this as a physical file within the nuget package? Or would a simple link on https://www.nuget.org/packages/PactNet/ to the readme suffice?
from pact-net.
If you add it to the nuget package you can get it to show in visual studio when the package is first installed.
It can then provide links etc to how to get started. i.e. I didn't realize the headers were part of the verification rather than the matching.
By they way I may use your mocking tool to test the MYOB SDK as it looks much nicer then what I currently have.
From: Neil Campbellmailto:[email protected]
Sent: 7/10/2014 4:31 PM
To: SEEK-Jobs/pact-netmailto:[email protected]
Cc: Shaun Wildemailto:[email protected]
Subject: Re: [pact-net] Add a 'readme' to the nuget package (#24)
Hey @sawilde. Do you see this as a physical file within the nuget package? Or would a simple link on https://www.nuget.org/packages/PactNet/ to the readme suffice?
Reply to this email directly or view it on GitHub:
#24 (comment)
from pact-net.
I'm not a massive fan of the show readme on install approach. A lot of the time, I know how a library works and I am just installing it in a new project, but yeah it certainly helps on the first install. I'm going to see what others think on this one.
With regards to the How to get started comment, I would love to hear all the things that bit you, as I know some of items are not documented in the Pact-Net readme. The one you mentioned is actually a really good example, it is document in the Pact specification project, however most users will not read that.
from pact-net.
The sample you gave in the readme.md was useful to getting started though I don't use xunit on my project (I did in the spike but will probably change it to nunit). Though it led me down a few wrong paths especially as it throws a 500 when you get the mock (expectation) wrong. I tried a lot of things to get it to work as I couldn't determine what was par of the expectation and what was part of the verification. By the way I think my next suggestion may be to add the doc xml file (I know people don't like code comments - but the doc xml file can be used to provide intellisense) again helps people get going quicker :)
Is there any way to see what has actually been set up so you can see what the expectation is i.e. url+query (I am assuming the query is part of the expectation) so when it goes pop you can look and go - "doh!"
from pact-net.
The readme can also be used to inform the user of breaking changes (hopefully none as you are awesome) and also help new users to the project when they upgrade it long after the original user has left the project that uses your package.
from pact-net.
Related Issues (20)
- Adding support for XML response expectation expressions HOT 4
- ClearInteraction when using messaging pacts HOT 5
- PactV3Options Port value not respected HOT 4
- Please share examples with .NET 6 new hosting model without Startup.cs HOT 4
- Pact-Net: PactConfig does not appear to have parity with Pact-JS - Missing [Host] and [Port] properties HOT 1
- docs req - contributing guide
- Improve error message output
- Several critical and high security issues in libraries used in nuget package PactNet.OSX 3.0.2 HOT 6
- Wrong result validation when publishing pacts? HOT 11
- 'WithSslVerificationDisabled' doesnt disable ssl verification HOT 12
- Pact testing of protobuf messages failing due to content type JSON HOT 4
- Pact Merging Creates Duplicate Interactions
- RFC: Pact Plugins HOT 3
- Pact json being overwritten by each test in C# .NET HOT 7
- Pact request body with inner object gives internal server error in Pact Net HOT 6
- Dynamic date in request HOT 3
- RFC: Add linux-musl-x64 Runtime Support HOT 3
- RFC: Add Linux (libc)-ARM Runtime Support HOT 2
- RFC: Support System.Text.Json default polymorphic type discriminator when using .WithJsonBody() HOT 2
- DevContainer: Unable to load shared library 'pact_ffi' or one of its dependencies HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from pact-net.