Skip to content

Latest commit

 

History

History
39 lines (27 loc) · 1.8 KB

CONTRIBUTING.md

File metadata and controls

39 lines (27 loc) · 1.8 KB

Contributing

Support

  1. Use the GitHub Issues only for development tasks and bug reports
  2. For anything else (questions, support, etc) use our Official Support Channels
  3. With bug reports, be sure to specify:
    1. Your docpad version docpad --version
    2. Your node version node --version
    3. Your npm version npm --version
    4. Your operating system's name, architecture, and version
    5. What you did
    6. What happened
    7. What you expected

Development

  1. Fork the DocPad Repository
  2. Clone your fork and cd into it
  3. Run npm install to install dependencies
  4. Run npm link to link our local copy as the global instance (so it is available via docpad)
  5. Run make dev to compile our coffeescript and recompile on changes

Pull Requests

  1. Each pull request should be made on its own branch. Branches should be stemmed from master. E.g. git checout master; git checkout -b your-new-branch
  2. Test your changes before you submit the pull request (see testing section), if possible, add tests for your change - if you don't know how to fix the tests, submit your pull request and say so, happy to help (but it will slow down integration)
  3. When submitting the pull request, specify the dev branch as the integration branch (the integration branch is which branch your pull request will be merged into on the official repo)
  4. If you'd like, feel free to add yourself to the contributors section of the package.json file if it exists
  5. By submitting a pull request, you agree that your submission can be used freely and without restraint by those whom your submitting the pull request to

Testing

  1. Run npm test to run the tests
  2. There are several types of tests run, the most common is the rendering test, which compares files inside test/out to test/out-expected