7

I am referring to the comments suggested in answers to share prewritten pro-forma-userscript comments.

Need they upvoting or do they just need someone to do the work? (that someone could be me, of course...)

4
  • I've removed the feature-request tag because you don't seem to ask for a feature. You can add it back later, but please clarify on this "feature" :)
    – Seth
    Commented Feb 28, 2013 at 22:29
  • I think those who have access to the github account will be reviewing how we do pull requests going forward to avoid breakage.
    – Marco Ceppi Mod
    Commented Mar 1, 2013 at 15:57
  • @MarcoCeppi I don't quite understand your comment.
    – Seth
    Commented Mar 1, 2013 at 17:28
  • @Seth thats fine with me, I was thinking along the line "I want something improved" and added it, but it is clearly solved :-))
    – guntbert
    Commented Mar 1, 2013 at 17:48

2 Answers 2

Reset to default
9

Are you talking about the remote sources? Those are hosted on GitHub for all to contribute to.

The project's page is here: AskUbuntu / ProFormaComments.

I must admit, it was my addition that caused that last parse error and made everything stop working ;) Thanks to AmithKK for finding and fixing it.

So, in order to get comments into the script, someone needs to fork the GitHub repo and submit a pull request. If you don't have a GitHub account, or find the process confusing (it is!), just ask someone else to do it for you :)

I have detailed the process for the curious:

First you need to fork the comments repo:

enter image description here

Then click on the file you want to edit (in this case comments.jsonp):

enter image description here

Next click "Edit":

enter image description here

Make your changes then add a summary and description describing your changes. Click "Submit Changes".

enter image description here

At this point your changes are only in your copy of the repository. To get them into the central script you'll have to submit a pull request. I recommend clicking "Raw" and using the URL to test your script before doing that.

When you're ready to submit your request, click "Pull Request" near the top.

enter image description here

Type out a title and description for your request and click "Submit pull request".

enter image description here

You're done! Your pull request has been submitted for the mods to review.

The comments are in jsonp, you'll have to use this format when submitting a request: 

{ "name": "[Q][A]Name in quotes", "description": "full comment in quotes"},

[Q] is used to mark comments that are for questions and [A] for comments that are used for answers. This is the basic pattern for Javascript Object Notation.

4

The script we use here uses a json file containing a set of useful comments. It is hosted on github and instructions for using it are included in the top answer.

To get yours submitted to this central script, you will need to make a pull request via github. It is really easy and simple to do, and I've added some comments this way myself.

3
  • Easy and simple? That's an overstatement.. IMO anyway.
    – Seth
    Commented Feb 28, 2013 at 22:21
  • @Seth Might not be a bad Q&A topic perhaps? I found this tutorial series very useful when I was starting out with git and github
    – Kevin Bowen
    Commented Feb 28, 2013 at 23:45
  • @maggotbrain I'll have to look at that video. I find the way GitHub operates rather confusing.. Would make a good Q/A :)
    – Seth
    Commented Feb 28, 2013 at 23:57

You must log in to answer this question.

Not the answer you're looking for? Browse other questions tagged .