Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Contributing

phun-ky edited this page · 4 revisions

Patsy is built with a set of modules, and we rely heavily on GruntJS. Patsy uses grunt for most of its task needs, and you can also runt grunt on patsy itself.

Table of Contents

  1. Filing issues
  2. Modifying patsy
  3. Developer docuemntation

Filing issues

If something isn't working like you think it should, please read the documentation, especially the Getting started guide.

If you have a question not covered in the documentation or want to report a bug, the best way to ensure it gets addressed is to file it in the appropriate issues tracker.

  • If there's an issue with patsy, or you are not sure where to file the issue
  • If there's an issue that is related to GruntJS

Simplify the issue

Try to reduce your code to the bare minimum required to reproduce the issue. This makes it much easier (and much faster) to isolate and fix the issue.

Explain the issue

If we can't reproduce the issue, we can't fix it. Please list the exact steps required to reproduce the issue. Include versions of your OS, Node.js, patsy, etc. Include relevant logs or sample code.

⬆ Go to the TOC

Modifying patsy

First, ensure that you have the latest Node.js and npm installed.

  1. Ensure grunt is installed (see the Getting started guide for GruntJS for more information)
  2. Fork and clone the repo.
  3. Check out the correct branch. Currently, patsy development happens in the devel branch.
  4. Run npm install to install all patsy dependencies.
  5. Run grunt in patsys folder to grunt patsy.

Assuming that you don't see any red, you're ready to go. Just be sure to run grunt after making any changes, to ensure that nothing has broken.

Note that patsy and grunt uses the SAME Gruntfile.js so be really sure to know what you are doing!

Submitting pull requests

  1. Create a new branch, please don't work in your master or devel branch directly.
  2. Add failing tests for the change you want to make. Run grunt to see the tests fail.
  3. Fix stuff.
  4. Run grunt to see if the tests pass. Repeat steps 2-4 until done.
  5. Update the documentation to reflect any changes.
  6. Push to your fork and submit a pull request.

Syntax

  • Two space indents. Don't use tabs anywhere. Use \t if you need a tab character in a string.
  • No trailing whitespace, except in markdown files where a linebreak must be forced.
  • Don't go overboard with the whitespace.
  • No more than one assignment per var statement.
  • Delimit strings with single-quotes ', not double-quotes ".
  • Prefer if and else to "clever" uses of ? : conditional or ||, && logical operators.
  • Comments are great. Just put them before the line of code, not at the end of the line.
  • When in doubt, follow the conventions you see used in the source already.

As a side note, we recommend the usage of .editorconfig.

⬆ Go to the TOC

Developer documentation

See Patsy developer documentation for dev docs

⬆ Go to the TOC

Something went wrong with that request. Please try again.