cordova-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Jesse <purplecabb...@gmail.com>
Subject Re: Adding Examples for Plugins in the ReadMe
Date Tue, 29 Mar 2016 17:31:22 GMT
Calling these 'tests' to me is way out of scope, and very easily broken.

Adding a demo project to a plugin makes sense from both a development
perspective AND a demonstration perspective. When developing, you need
something to actually exercise the api you are writing, so putting this in
the repo makes sense because it also allows someone else to use it to
augment the apis, and provides a simple demonstration of the apis in use.

If you find yourself writing a demo/example that involves several plugins,
then I would recommend we put all of those in a new repo: demos, examples,
recipes, ...




@purplecabbage
risingj.com

On Tue, Mar 29, 2016 at 7:09 AM, Carlos Santana <csantana23@gmail.com>
wrote:

> "With great power comes great responsibilities"
>
> Adding this would require responsibilities of maintenance and up to date
> working examples backed up with CI.
>
> In other words it's good idea to add docs with more complex examples on how
> to use the plugin, some of them already are located in mobilespec and
> plugin test cases, which give us confident that scenario are in good shape.
> anything not already covered by CI would require to write test cases to
> make sure examples continue to work with plugin and platforms changes.
>
> I would not put the content in a 3rd party Git Repo if it's something that
> is part of the Apache Cordova project. Just request a INFRA ticket for git
> repo to be created.
> We can start with one like Jesse said "cordova-demos" or "cordova-examples"
> either one is fine
>
>
>
>
> On Tue, Mar 29, 2016 at 12:56 AM Robert Posener <rposener8@gmail.com>
> wrote:
>
> > Also...
> > These examples could be developed in such a way as to become part of the
> > Cordova automated testing that is performed before a new version release,
> > thereby adding more complex tests to the test suite.
> > You'll need to be careful of this anyway (ie, It would look pretty bad if
> > these examples were copied by a Cordova app developer exactly as shown
> and
> > then they didn't work).
> >
> > Regards
> > *Rob Posener*
> > 0419 012 627
> >
> > On 29 March 2016 at 11:10, Parashuram N <panarasi@microsoft.com> wrote:
> >
> > > Including a demo folder in each plugin is good. If it is checked in, we
> > > ensure that the example and the plugin use the same version of the API.
> > > However, there may be some examples (typically in the file plugin area)
> > > where a good scenario would mean using 2 plugins. What do we do for
> that
> > ?
> > >
> > > -----Original Message-----
> > > From: Jesse [mailto:purplecabbage@gmail.com]
> > > Sent: Monday, March 28, 2016 4:51 PM
> > > To: dev@cordova.apache.org
> > > Subject: Re: Adding Examples for Plugins in the ReadMe
> > >
> > > Awesome.
> > > I typically include a demo folder with inside my plugin repos, but this
> > > does mean that this demo code gets copied all over the place if a user
> > > installs a plugin via git-repo or clone.
> > > I npm-ignore the demo folder so at least it does not go to npm ...
> > >
> > > Here's an example:
> > > https://github.com/purplecabbage/phonegap-plugin-sidebar/
> > >
> > >
> > > We could also create a cordova-demos repo in apache which has a demo
> > > project for each core plugin.
> > >
> > > Cheers,
> > >   Jesse
> > >
> > >
> > >
> > > @purplecabbage
> > >
> > >
> >
> https://na01.safelinks.protection.outlook.com/?url=risingj.com&data=01%7c01%7cpanarasi%40microsoft.com%7c11a99a9b7d574cb3752408d35763e384%7c72f988bf86f141af91ab2d7cd011db47%7c1&sdata=7NrDVGF57%2f02i6dLIGOb9tKyJbxoj8QgVa3cyTUAKLg%3d
> > >
> > > On Mon, Mar 28, 2016 at 4:26 PM, Robert Posener <rposener8@gmail.com>
> > > wrote:
> > >
> > > > +500
> > > >
> > > > Regards
> > > > *Rob Posener*
> > > > 0419 012 627
> > > >
> > > > On 29 March 2016 at 08:47, Parashuram N <panarasi@microsoft.com>
> > wrote:
> > > >
> > > > > Hey folks,
> > > > >
> > > > > At the moment, the sample code in our plugins is limited to only
> > > > > show basic usage of the API. While this is great for someone who
> has
> > > > > already written Cordova projects, I believe that we may need more
> > > > > examples for folks who are just getting started with Cordova.
> > > > > To improve our documentation, Norm has sent out a pull request with
> > > > > additional examples that show the typical use cases for the plugins
> > > > > -
> https://github.com/apache/cordova-plugin-geolocation/pull/74/files
> > > > >
> > > > > This PR is the first in a set of work that we would like to do, to
> > > > improve
> > > > > documentation for plugins. A few questions to the community about
> > > > > this direction
> > > > >
> > > > >
> > > > > 1.       Is it ok to include this as a part of the README ? That
> > would
> > > > > increase the visibility of the examples much more. We could have
a
> > > > > "REFERENCE" section that is for quick reference, and then this set
> > > > > of detailed examples showing how the plugins work. Anyone have
> > > > > objections to that ? Note that the README would be longer, but I
> > > > > think that should be
> > > > ok.
> > > > > Also note that the README is imported into the Cordova docs, so
> > > > > these examples will also show up there
> > > > >
> > > > > 2.       Some of the example have links to full projects that use
> the
> > > > > plugin. We did not find a place on the Apache github organization
> to
> > > > > put
> > > > it
> > > > > all up, so they currently reside in a Microsoft-github
> organization.
> > > > > Is that ok ? Is there a place to put full fledged Cordova samples
> on
> > > > > the Apache repos ?
> > > > >
> > > >
> > >
> >
>

Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message