Skip to content

Latest commit

 

History

History
17 lines (14 loc) · 1.39 KB

CONTRIBUTING.md

File metadata and controls

17 lines (14 loc) · 1.39 KB

Pull Requests

  • All changes, from core team and not, should be in the form of a pull request from a branch.
  • Pull request description should explain what the problem was and what steps you took to fix it.
  • After a pull request has been merged in, we'll use the "Delete Branch" button (especially for branches in origin).

Tests

  • All code should have appropriate batman tests. Apps shouldn't need to test the framework; the framework should test the framework.
  • Ideally each commit should be a self-contained unit of new code passing the test suite, but the only real requirement is that the branch or pull request, when done, should pass the test suite.

Building

  • Do not include built files with source change commits. It makes the commits hard to diff and revert.
  • After a branch or pull request has been completed and merged into master, build dist in a single "Build" commit.

Documentation

  • Anyone can help contribute to the percolate docs, even without contributing code! Percolate is a tool that makes it easy to write documentation in Markdown without looking at a bunch of source code and optionally including inline examples and tests.
  • If you're adding a new batman feature or changing an existing API or feature, it would be AWESOME if you could include percolate docs with the pull request.
  • Docs are required for core team pull requests, but just highly appreciated for external contributors.