Skip to content

Sentence syntax correction #467

Closed
wants to merge 1 commit into from

2 participants

@toejough
toejough commented Feb 8, 2014

The original sentence does not make sense - "The ... method places the selected element(s) after the element that provided as an argument". "that was provided" would make more sense, but so does "the element provided", which is the syntax used in the following, similar sentence.

@toejough toejough Sentence syntax correction
The original sentence does not make sense - "The ... method places the selected element(s) after the element that provided as an argument".  "that was provided" would make more sense, but so does "the element provided", which is the syntax used in the following, similar sentence.
69cb393
@scottgonzalez scottgonzalez added a commit that closed this pull request Apr 3, 2014
@scottgonzalez scottgonzalez Manipulating Elements: Fix typo
Closes gh-467
8c6129f
@scottgonzalez
jQuery Foundation member

Thanks. If you're interested in contributing in the future, please read the contributing guidelines.

@toejough

Sorry, I'm a bit new at the github flow...what exactly did I do wrong? Why did you re-implement my correction rather than just accepting my pull request?

@scottgonzalez
jQuery Foundation member

I assume you didn't read the contributing guidelines that I linked to (which are also linked at the top of the page when creating a pull request). You didn't sign the CLA, you used an anonymous email address, you didn't follow the commit message format, etc. For such a minor change, it's much easier to just do this ourselves.

@toejough

First, I apologize for messing up so thoroughly, and I recognize that it can be annoying to have newcomers messing things up. Thank you for taking time to respond.

To clarify, I asked for specifics because I did read the contributing guidelines, both before and after you pointed me at them.

That main page (which I read before submitting) gives an example commit message ('Commit the files to your local repo: git commit -m "add a relevant message describing the change"'), tells you to push it, then submit a pull request. The "pull request" link just takes you to the github page for pull-requests. I followed that guideline.

Instead of being welcomed as a new contributor (which the guidelines make a big deal about), you stole my (admittedly minor) fix and told me to follow the guidelines next time. I thought I had.

After that, I read the linked page again, and then also the "get more advice" page for pull requests at http://contribute.jquery.org/commits-and-pull-requests/ . I recognized then that I hadn't followed the commit message guidelines, but that would've been easy to fix had it been pointed out to me. I figured I must've screwed up something much more fundamental, but I didn't understand what, which is why I asked for specifics.

There isn't anything on either page about a CLA or about non-anonymous email. I did finally find the CLA/email info in another tab on the commits-and-pull-requests site, but it's not linked or even referenced from the main guidelines page or from the commits-and-pull-requests article. Not knowing about it before-hand, there was no reason for me to go looking for it. I did discover after searching the jquery site that maintainers are very clearly asked to verify those, but it's not clear to contributors that we need to supply them.

Before I open a bug addressing this...do you agree? Is there a hole here, or do you see something I have just completely missed in the documentation at https://github.com/jquery/learn.jquery.com/blob/master/CONTRIBUTING.md ?

@scottgonzalez
jQuery Foundation member

First, I apologize for messing up so thoroughly, and I recognize that it can be annoying to have newcomers messing things up. Thank you for taking time to respond.

It's not annoying at all. You found a problem, provided a solution, and we got it fixed. That's immensely helpful and we appreciate the work you did. It was just easier to land the fix myself than having you go through the full process for such a small change (especially when we're not sure if you'll be a repeat contributor). When we make that decision, we always point to the contributing guidelines and mention future contributions in the hope the contributor will continue to contribute (and hopefully follow the guidelines in the future).

That main page (which I read before submitting) gives an example commit message ('Commit the files to your local repo: git commit -m "add a relevant message describing the change"'), tells you to push it, then submit a pull request. The "pull request" link just takes you to the github page for pull-requests. I followed that guideline.

We'll need to update that. Can you point to the specific page you were looking at so we can improve it? I just looked at the contributing guidelines for this repo and realized that it's much more involved than our standard guidelines. I'll see if we can simplify this and get it in line with the other repos. (I work on about two dozen jQuery repos and they mostly have the same, minimal guideline which just points to contribute.jquery.org, e.g., https://github.com/jquery/jquery.com/blob/master/CONTRIBUTING.md)

After that, I read the linked page again, and then also the "get more advice" page for pull requests at http://contribute.jquery.org/commits-and-pull-requests/ . I recognized then that I hadn't followed the commit message guidelines, but that would've been easy to fix had it been pointed out to me. I figured I must've screwed up something much more fundamental, but I didn't understand what, which is why I asked for specifics.

Sorry that the guidelines led you astray. It's important for us to fix this so that this doesn't keep happening to other new contributors. If you have any suggestions for improvements to this repo's contributing guidelines or the content on contribute.jquery.org please let us know. We're always trying to improve.

There isn't anything on either page about a CLA or about non-anonymous email. I did finally find the CLA/email info in another tab on the commits-and-pull-requests site, but it's not linked or even referenced from the main guidelines page or from the commits-and-pull-requests article. Not knowing about it before-hand, there was no reason for me to go looking for it. I did discover after searching the jquery site that maintainers are very clearly asked to verify those, but it's not clear to contributors that we need to supply them.

Before I open a bug addressing this...do you agree? Is there a hole here, or do you see something I have just completely missed in the documentation at https://github.com/jquery/learn.jquery.com/blob/master/CONTRIBUTING.md ?

It sounds like this may all stem from this repo's contributing guidelines not being in sync with the rest of our repos. If this matched the jquery.com guideline linked above would that have avoided the problems?

@toejough

ha, the reply chain gets longer and longer.

Thanks Scott. In response to your final question, yes, I think so. The jquery.com guideline looks pretty straightforward - I would like to think that if I'd seen that first I'd have done things the right way.

Should I log a bug for that, or is that something you'll just talk about with the other maintainers?

The example commit message I referenced is #6 here: https://github.com/jquery/learn.jquery.com/blob/master/CONTRIBUTING.md#working-with-content

@scottgonzalez
jQuery Foundation member

Should I log a bug for that, or is that something you'll just talk about with the other maintainers?

Feel free to file an issue so that it doesn't get lost.

The example commit message I referenced is #6 here: https://github.com/jquery/learn.jquery.com/blob/master/CONTRIBUTING.md#working-with-content

This is a perfect example of why we shouldn't be duplicating content. This was never updated when we formalized the commit message format for all projects. Simplifying this document will definitely help.

@toejough

Cool. Submitted as #554

@arthurvr arthurvr pushed a commit to arthurvr/learn.jquery.com that referenced this pull request Jan 4, 2015
@scottgonzalez scottgonzalez Manipulating Elements: Fix typo
Closes gh-467
cc62fc0
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Something went wrong with that request. Please try again.