Skip to content

Suggested OT texts for new PR

Dan Dascalescu edited this page Feb 13, 2015 · 7 revisions

Proposal 1 (first attempt)

Below is the raw Markdown of a pull request proposal for a 3rd party library author.

Hello guys,

As you might know, the [Meteor](https://www.meteor.com/) community is widely using
<PACKAGE NAME HERE>. We had many different wrapper packages all doing the same thing,
so I'm submitting a PR that integrates Meteor packaging directly into your repository:
at the end of this merge process, in case you'll find yourself comfortable with it, we'll
get automated new Meteor package releases with every new release of <PACKAGE NAME HERE>.

I've made this PR as lean as possible so as not to take up too much space within your
repository: basically it adds only a `package.js` file among the ones already present
for other package managers.

All you have to do after accepting this PR would be:

1. Create an account at https://meteor.com/ (click #, then Create account).
After you've done that, please let me know the name of the account, and we'll add you
as a maintainer of the `Organization Name Here` organization (which has been already
reserved to make things simpler for you).

2. Activate your repo on *autopublish.meteor.com*  
  1. Head to [autopublish.meteor.com](http://autopublish.meteor.com/), # with your
     GitHub account, locate this repository and enable it for autopublish by toggling the checkbox
     you'll find on the right side of the repository item. You can get an idea about how Meteor
     Autopublish works on [this page](http://autopublish.meteor.com/howitworks), but basically
     it creates a [web hook](https://help.github.com/articles/about-webhooks/) to let us know
     when you push new tags. When you'll release new versions, autopublish.meteor.com will
     automatically package the the new version of the library also for Meteor!

  2. In case you're not comfortable with autopublish.meteor.com maintaining access rights to
     your repos, please head to [GitHub Application Settings](https://github.com/settings/applications)
     and revoke permissions for *Meteor Autopublish*.

  Please note that you will not be able to toggle your repository until you have the `package.js` file on
  your master branch.

3. Alternatively, in case you're not willing to give read/write rights to your public repositories
to anyone else but you (which is understandable), we will be available to provide a step-by-step
guide to manually creating the required webhook.

Please also note that we've already published the current version of the package on
[Atmosphere](https://atmospherejs.com/ORG-NAME/PACKAGE-NAME) [`<-- UPDATE LINK`]
(Meteor's package directory) under the name `<PACKAGE NAME HERE>`. If you think another
name would be a better fit, just let us know!

Thanks in advance for your availability and collaboration and congratulations on the awesome project!

<YOUR NAME HERE> & the [Meteor Packaging Team](https://github.com/orgs/MeteorPackaging/people)