Skip to content

Commit

Permalink
Contribution guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
pkozlowski-opensource committed Nov 4, 2012
1 parent 6a97147 commit cdcef31
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 1 deletion.
12 changes: 12 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
We are always looking for the quality contributions and will be happy to accept your Pull Requests as long as those adhere to some basic rules:

* Please make sure that your contribution fits well in the project's context:
* we are aiming at rebuilding boostrap directives in pure AngularJS, without any dependencies on any external JavaScript library;
* the only dependency should be boostrap CSS and its markup structure;
* directives should be html-agnostic as much as possible which in practice means:
* templates should be referred to using the `templateUrl` property
* it should be easy to change a default template to a custom one
* directives shouldn't manipulate DOM structure directly (when possible)
* Please assure that you are submitting quality code, specifically make sure that:
* your directive has accompanying tests and all the tests are passing; don't hesitate to contact us ([email protected]) if you ned any help with unit testing
* your PR doesn't break the build; check the Travis-CI build status after opening a PR and push corrective commits if anything goes wrong
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,8 @@
* Run test: `grunt test-run`

### Before commit
* Build the whole project: `grunt` - this will run `lint`, `test`, and `concat` targets
* Build the whole project: `grunt` - this will run `lint`, `test`, and `concat` targets

## Contributing to the project

We are always looking for the quality contributions! Please check the CONTRIBUTING.md for the contribution guidelines.

0 comments on commit cdcef31

Please sign in to comment.