Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP

Loading…

Fixed some MarkDown bugs in CONTRIBUTING.md. #931

Closed
wants to merge 1 commit into from

3 participants

@callumacrae

I'm assuming that I don't need a ticket for this?

@dmethvin
Owner

No ticket needed, we can just merge these. Thanks eagle-eye!

@rwaldron
Collaborator

Thanks for this

A good portion of the content was copied from sources that used MediaWiki (I think?) syntax, so definitely appreciate the second set of eyes reviewing this.

@rwaldron rwaldron closed this in c3b1367
@mescoda mescoda referenced this pull request from a commit in mescoda/jquery
@callumacrae callumacrae Fixes to contributing.md. Closes gh-931 854f828
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Commits on Sep 20, 2012
  1. @callumacrae
This page is out of date. Refresh to see the latest.
Showing with 5 additions and 6 deletions.
  1. +5 −6 CONTRIBUTING.md
View
11 CONTRIBUTING.md
@@ -12,16 +12,15 @@
There are a number of ways to get involved with the development of jQuery core. Even if you've never contributed code to an Open Source project before, we're always looking for help identifying bugs, writing and reducing test cases and documentation.
-
This is the best way to contribute to jQuery core. Please read through the full guide detailing [How to Report Bugs](#How-to-Report-Bugs).
## Discussion
### Forum and IRC
-The jQuery core development team frequently tracks posts on the [http://forum.jquery.com/developing-jquery-core jQuery Development Forum]. If you have longer posts or questions please feel free to post them there. If you think you've found a bug please [file it in the bug tracker](#How-to-Report-Bugs).
+The jQuery core development team frequently tracks posts on the [jQuery Development Forum](http://forum.jquery.com/developing-jquery-core). If you have longer posts or questions please feel free to post them there. If you think you've found a bug please [file it in the bug tracker](#How-to-Report-Bugs).
-Additionally most of the jQuery core development team can be found in the [http://webchat.freenode.net/?channels=jquery-dev #jquery-dev] IRC channel on irc.freenode.net.
+Additionally most of the jQuery core development team can be found in the [#jquery-dev](http://webchat.freenode.net/?channels=jquery-dev) IRC channel on irc.freenode.net.
### Weekly Status Meetings
@@ -38,7 +37,7 @@ The meeting is held in the [#jquery-meeting](http://webchat.freenode.net/?channe
Many bugs reported to our bug tracker are actually bugs in user code, not in jQuery code. Keep in mind that just because your code throws an error and the console points to a line number inside of jQuery, this does *not* mean the bug is a jQuery bug; more often than not, these errors result from providing incorrect arguments when calling a jQuery function.
-If you are new to jQuery, it is usually a much better idea to ask for help first in the [http://forum.jquery.com/using-jquery Using jQuery Forum] or the [http://webchat.freenode.net/?channels=%23jquery jQuery IRC channel]. You will get much quicker support, and you will help avoid tying up the jQuery team with invalid bug reports. These same resources can also be useful if you want to confirm that your bug is indeed a bug in jQuery before filing any tickets.
+If you are new to jQuery, it is usually a much better idea to ask for help first in the [Using jQuery Forum](http://forum.jquery.com/using-jquery) or the [jQuery IRC channel](http://webchat.freenode.net/?channels=%23jquery). You will get much quicker support, and you will help avoid tying up the jQuery team with invalid bug reports. These same resources can also be useful if you want to confirm that your bug is indeed a bug in jQuery before filing any tickets.
### Disable any browser extensions
@@ -56,7 +55,7 @@ Sometimes, bugs are introduced in newer versions of jQuery that do not exist in
### Reduce, reduce, reduce!
-When you are experiencing a problem, the most useful thing you can possibly do is to [http://webkit.org/quality/reduction.html reduce your code] to the bare minimum required to reproduce the issue. This makes it *much* easier to isolate and fix the offending code. Bugs that are reported without reduced test cases take on average 9001% longer to fix than bugs that are submitted with them, so you really should try to do this if at all possible.
+When you are experiencing a problem, the most useful thing you can possibly do is to [reduce your code](http://webkit.org/quality/reduction.html) to the bare minimum required to reproduce the issue. This makes it *much* easier to isolate and fix the offending code. Bugs that are reported without reduced test cases take on average 9001% longer to fix than bugs that are submitted with them, so you really should try to do this if at all possible.
## jQuery Core Style Guide
@@ -127,7 +126,7 @@ Now open the jQuery test suite in a browser at http://localhost/test. If there i
Success! You just built and tested jQuery!
-### Fix a bug from a ticket filed at bugs.jquery.com: ===
+### Fix a bug from a ticket filed at bugs.jquery.com:
**NEVER write your patches to the master branch** - it gets messy (I say this from experience!)
Something went wrong with that request. Please try again.