Skip to content

Commit

Permalink
[added] HuBoard badge and link
Browse files Browse the repository at this point in the history
Issue triage, prioritizing and general state tracking support with
HuBoard. This should help to coordinate efforts and demonstrate
priorities of the core dev team.
  • Loading branch information
mtscout6 committed Mar 31, 2015
1 parent 694b701 commit c8dda3f
Show file tree
Hide file tree
Showing 2 changed files with 65 additions and 15 deletions.
29 changes: 20 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,11 @@ don't hesitate to jump in.

## Current Issues

Feel free to tackle any currently open
[issue](https://github.com/react-bootstrap/react-bootstrap/issues). The issues
tagged with "help wanted" are especially open.
[![HuBoard][huboard-badge]][huboard]

We use HuBoard to triage issues and prioritize the backlog for the core dev
team. Feel free to tackle any currently open [issue][issues]. The issues tagged
with "help wanted" and especially those high in the backlog are fair game.

## Tests

Expand All @@ -17,11 +19,11 @@ All commits that fix bugs or add features need a test.

Please adhere to the current code styling. We have included an `.editorconfig`
at the repo's root to facilitate uniformity regardless of your editor. See the
[editor config site](http://editorconfig.org/) for integration details.
[editor config site][editorconfig] for integration details.

We use [ESLint](http://eslint.org/) for all JavaScript Linting. There should be
no linting errors and no new warnings for new work. You are welcome to configure
your editor to use ESLint or the `npm test` command will run unit tests and the
We use [ESLint][eslint] for all JavaScript Linting. There should be no linting
errors and no new warnings for new work. You are welcome to configure your
editor to use ESLint or the `npm test` command will run unit tests and the
linter.

## Commit Subjects for Public API Changes
Expand All @@ -43,10 +45,19 @@ change the public API.
Please include an upgrade path with example code in the commit message. If it
doesn't make sense to do this, then it doesn't make sense to use `[changed]` or
`[removed]` :). For further reading on writing a well formed commit message,
check out these [5 useful tips for a better commit
message](http://robots.thoughtbot.com/5-useful-tips-for-a-better-commit-message)
check out these [5 useful tips for a better commit message][commit-message]

## Docs

Please update the docs with any API changes, the code and docs should always be
in sync.

[huboard-badge]: https://img.shields.io/badge/Hu-Board-7965cc.svg
[huboard]: https://huboard.com/react-bootstrap/react-bootstrap

[issues]: https://github.com/react-bootstrap/react-bootstrap/issues

[editorconfig]: http://editorconfig.org
[eslint]: http://eslint.org
[commit-message]: http://robots.thoughtbot.com/5-useful-tips-for-a-better-commit-message

51 changes: 45 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,22 @@
# react-bootstrap

[Bootstrap 3](http://getbootstrap.com) components built with [React](http://facebook.github.io/react/)
[Bootstrap 3][bootstrap] components built with [React][react]

[![Build Status](https://travis-ci.org/react-bootstrap/react-bootstrap.svg)](https://travis-ci.org/react-bootstrap/react-bootstrap) [![NPM version](https://badge.fury.io/js/react-bootstrap.svg)](http://badge.fury.io/js/react-bootstrap) [![Bower version](https://badge.fury.io/bo/react-bootstrap.svg)](http://badge.fury.io/bo/react-bootstrap) [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/react-bootstrap/react-bootstrap?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![Build Status][build-badge]][build]
[![NPM version][npm-badge]][npm]
[![Bower version][bower-badge]][bower]
[![HuBoard][huboard-badge]][huboard]
[![Gitter][gitter-badge]][gitter]

[![Dependency Status](https://david-dm.org/react-bootstrap/react-bootstrap.svg)](https://david-dm.org/react-bootstrap/react-bootstrap) [![devDependency Status](https://david-dm.org/react-bootstrap/react-bootstrap/dev-status.svg)](https://david-dm.org/react-bootstrap/react-bootstrap#info=devDependencies) [![peerDependency Status](https://david-dm.org/react-bootstrap/react-bootstrap/peer-status.svg)](https://david-dm.org/react-bootstrap/react-bootstrap#info=peerDependencies)
[![Dependency Status][deps-badge]][deps]
[![devDependency Status][dev-deps-badge]][dev-deps]
[![peerDependency Status][peer-deps-badge]][peer-deps]

Under active development - APIs will change.

## Docs

See the [documentation](http://react-bootstrap.github.io) with live editable examples.
See the [documentation][documentation] with live editable examples.

## Authors

Expand All @@ -21,7 +27,7 @@ and many [contributors](https://github.com/react-bootstrap/react-bootstrap/graph

## Related modules

- [react-router-bootstrap](https://github.com/mtscout6/react-router-bootstrap) - Integration with [react-router](https://github.com/rackt/react-router).
- [react-router-bootstrap][react-router-bootstrap] - Integration with [react-router][react-router].

## Local Setup

Expand All @@ -34,4 +40,37 @@ and many [contributors](https://github.com/react-bootstrap/react-bootstrap/graph

## Contributions

Yes please! See the [contributing guidelines](https://github.com/react-bootstrap/react-bootstrap/blob/master/CONTRIBUTING.md) for details.
Yes please! See the [contributing guidelines][contributing] for details.

[bootstrap]: http://getbootstrap.com
[react]: http://facebook.github.io/react/

[documentation]: http://react-bootstrap.github.io
[contributing]: https://github.com/react-bootstrap/react-bootstrap/blob/master/CONTRIBUTING.md

[build-badge]: https://travis-ci.org/react-bootstrap/react-bootstrap.svg
[build]: https://travis-ci.org/react-bootstrap/react-bootstrap

[npm-badge]: https://badge.fury.io/js/react-bootstrap.svg
[npm]: http://badge.fury.io/js/react-bootstrap

[bower-badge]: https://badge.fury.io/bo/react-bootstrap.svg
[bower]: http://badge.fury.io/bo/react-bootstrap

[gitter-badge]: https://badges.gitter.im/Join%20Chat.svg
[gitter]: https://gitter.im/react-bootstrap/react-bootstrap?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge

[deps-badge]: https://david-dm.org/react-bootstrap/react-bootstrap.svg
[deps]: https://david-dm.org/react-bootstrap/react-bootstrap

[dev-deps-badge]: https://david-dm.org/react-bootstrap/react-bootstrap/dev-status.svg
[dev-deps]: https://david-dm.org/react-bootstrap/react-bootstrap#info=devDependencies

[peer-deps-badge]: https://david-dm.org/react-bootstrap/react-bootstrap/peer-status.svg
[peer-deps]: https://david-dm.org/react-bootstrap/react-bootstrap#info=peerDependencies

[react-router-bootstrap]: https://github.com/mtscout6/react-router-bootstrap
[react-router]: https://github.com/rackt/react-router

[huboard-badge]: https://img.shields.io/badge/Hu-Board-7965cc.svg
[huboard]: https://huboard.com/react-bootstrap/react-bootstrap

0 comments on commit c8dda3f

Please sign in to comment.