Meta tags:

Headings (most frequently used words):

writing, contribute, submitting, tickets, code, the, importance, of, testing, common, mistakes, documentation, unit, tests,

Text of the page (most frequently used words):
the (60), you (38), and (28), test (25), tests (21), run (18), prototype (16), your (15), #documentation (13), for (13), that (13), rake (12), code (10), this (10), pull (9), should (9), patches (9), all (8), can (8), browsers (8), unit (8), from (7), will (7), use (6), don (6), which (6), new (6), see (6), source (5), like (5), have (5), want (5), out (5), request (5), open (5), but (5), requests (5), when (5), try (5), testing (5), some (5), start (5), string (5), then (4), write (4), doc (4), has (4), browser (4), dist (4), cases (4), patch (4), with (4), make (4), files (4), src (4), file (4), ajax (4), only (4), fork (4), javascript (4), branch (4), generate (3), version (3), also (3), changes (3), pdoc (3), build (3), project (3), firefox (3), add (3), tickets (3), are (3), git (3), bug (3), issue (3), used (3), specific (3), what (3), been (3), instead (3), supported (3), create (3), github (3), server (3), first (3), http (3), 127 (3), 4567 (3), return (3), window (3), directory (3), main (3), ruby (3), need (3), contribute (3), scary (3), core (2), team (2), useful (2), just (2), check (2), made (2), submit (2), methods (2), html (2), root (2), uses (2), how (2), same (2), writing (2), find (2), someone (2), one (2), without (2), important (2), feature (2), broken (2), reports (2), tell (2), cover (2), every (2), enough (2), these (2), common (2), include (2), applied (2), fail (2), features (2), submitting (2), them (2), get (2), they (2), ensure (2), break (2), library (2), across (2), assertions (2), our (2), own (2), keep (2), here (2), done (2), now (2), failing (2), array (2), line (2), named (2), chrome (2), task (2), installed (2), system (2), automated (2), url (2), few (2), look (2), any (2), submodules (2), submodule (2), repo (2), framework (2), licenses, mit, license, 2006, 2023, local, older, tag, help, since, able, preview, before, classes, placed, subfolder, view, index, looks, specially, formatted, comments, extracts, narrative, builds, around, process, similar, hard, drive, official, duplicate, search, lighthouse, beat, aren, cross, least, another, regard, execution, speed, slow, down, marginal, utility, claim, things, fact, reporter, simply, forgotten, describe, reproduce, give, detailed, steps, exhibit, very, frameworks, scenario, ever, imagined, concentrate, more, commonly, stuff, application, seen, mistakes, order, document, fixed, reason, after, pass, fix, bugs, demonstrate, functionality, introduce, please, written, rare, exception, yourself, waiting, else, vastly, increase, chance, acceptance, won, accompanying, adding, not, old, ones, behaves, way, importance, along, tdd, style, convenience, added, static, test_helpers, proclaim, mocha, follow, conventions, already, laid, forget, pick, low, hanging, performance, fruit, constructs, such, loops, variable, names, nice, descriptive, two, spaces, tabs, coding, guidelines, crazy, choice, fun, change, foo, hello, save, distributable, function, method, near, top, lang, something, purpose, both, report, results, back, runner, instance, second, terminal, against, supports, fashion, put, instructed, likely, take, moments, bunch, passed, failed, using, predefined, single, merges, while, relies, fetch, those, demand, update, init, started, clone, disk, either, most, directories, there, resides, provides, well, recent, its, default, windows, users, consolidated, suite, click, installer, modern, web, operating, handle, course, favorite, editor, latest, tree, work, development, master, commit, topic, repository, strongly, prefers, arrive, form, model, thus, described, describing, filing, probably, opens, popup, time, scares, var, boo, alert, less, thank, title, concise, heart, full, description, box, snippet, text, mark, appropriately, track, account, easy, sign, issues, ideas, other, interesting, discussions, api, contributions, additional, believe, hasn, got, coverage, enhancement, proving, certain, welcomes, weblog, home,

Text of the page (random words):
prototype javascript framework contribute home documentation weblog contribute prototype welcomes any and all of these bug reports failing tests proving some feature is broken in certain cases patches pull requests enhancement requests additional tests for code that you believe hasn t got enough coverage api documentation contributions ideas and other interesting discussions submitting tickets the prototype core team uses github issues to track tickets if you don t have an account it s easy to sign up try to keep the title concise but write your heart out in the full description box if you need to include a snippet of javascript code in your text mark it up appropriately like so this line opens a popup every time which scares me javascript var scary boo window alert scary can prototype be used to make this less scary thank you if you have a patch for the issue you re describing instead of filing a new issue you should probably make a pull request writing code prototype is on github and strongly prefers that patches arrive in the form of pull requests we use the fork and pull model as described here thus when you want to contribute a patch you should fork the main prototype repository create a topic branch on your fork and commit some changes to that branch make a pull request from that branch to the main repo s master branch to work on prototype development you ll need the latest version of the prototype source tree your favorite code editor all the modern web browsers your operating system can handle to test in of course a recent version of ruby and its rake library ruby is installed by default on os x but windows users will need to use the one click ruby installer rake is used to build the consolidated javascript file and to run our automated test suite across supported browsers to get started clone the project to your disk either from the main repo or from your fork this will create a new directory named prototype the most important directories in there are src in which all the code resides and test which provides a testing framework as well as all the unit tests prototype relies on a few submodules but it will try to fetch those submodules on demand or instead you can run git submodule init and git submodule update while in the root directory of the project run rake dist this predefined rake task merges all the source files from src to a single file dist prototype js unit tests use this file unit tests to see what unit tests look like open up the test unit tests directory and look at any of the test js files to start up a server for testing run rake test start and open a browser window to the instructed url likely http 127 0 0 1 4567 test the tests will take a few moments to run but when they re done you should see a bunch of passed tests and no failed tests if you re using a supported browser that is if you want to run only some of the files you see in test unit tests you can put them in the url http 127 0 0 1 4567 test ajax string will run only the tests in ajax test js and string test js if you want to run tests in an automated fashion you can start up the server with rake test start then run rake test run in a second terminal window the test run task should run the tests against all the browsers which prototype supports and which are installed on your system you can tell the runner to use only specific browsers or to run only specific tests for instance rake test run browsers firefox chrome tests ajax string will run the tests from ajax test js and string test js in both firefox and chrome and report the results back to you to see tests fail try to break something on purpose open src lang array js and find the method named first near the top first function return this 0 just for the fun of it change the return line to return a string like foo or hello and save the file then run rake dist to build a new distributable now start the test server and open http 127 0 0 1 4567 test array in a browser of your choice you should see that the first test is now failing from here you re on your own make changes to source files in src add your methods go crazy when you re done create a pull request on github some coding guidelines two spaces no tabs keep variable names nice and descriptive don t forget to pick low hanging performance fruit in common constructs such as loops follow the conventions already laid out in the code we use mocha for testing along with proclaim s tdd style assertions we add some of our own assertions for convenience check out test unit static js test_helpers js to see what s been added the importance of testing with unit testing we ensure adding new features will not break old ones we also ensure that the library behaves the same way across all supported browsers when you re submitting a pull request please also submit tests to cover the code you ve written with rare exception patches won t get applied if they don t have accompanying tests if you write the tests yourself instead of waiting for someone else to write them for you you vastly increase your patch s chance of acceptance patches that introduce new features should have test cases that demonstrate the new functionality patches that fix bugs should include test cases in order to document what has been fixed for this reason your test cases should fail without your patch and pass after it has been applied common mistakes we ve seen enough of these very application specific requests patches frameworks don t try to cover every scenario ever imagined so try to concentrate on more commonly used stuff bug reports that don t describe how to reproduce the issue give us detailed steps and tell us which browsers exhibit the bug tickets that claim things are broken when in fact the reporter has simply forgotten to git pull or rake dist patches made without regard to execution speed don t slow down important code to add a feature of marginal utility patches that aren t cross browser test in at least 2 browsers firefox and another one duplicate requests or patches search lighthouse to find out if someone has beat you to it writing documentation prototype uses pdoc for documentation pdoc looks at specially formatted comments in the source code and extracts narrative documentation then builds html around it this is how we generate the official documentation but you can use this same process to generate similar documentation on your hard drive from the project root run rake doc and pdoc should build documentation for all of prototype s classes and methods the documentation is placed in the doc subfolder so you can open doc index html to view it this is useful if you d like to have local documentation or if you want to generate documentation for an older version of prototype just check out the tag you want then run rake doc it s also useful if you d like to help write documentation since you re able to preview the changes you ve made before you submit a pull request 2006 2023 prototype core team licenses mit license source code and cc by sa documentation