vhad/react-bootstrap-table2
1
0
Fork 0
mirror of https://github.com/gosticks/react-bootstrap-table2.git synced 2025-10-16 11:55:39 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Improve CONTRIBUTING doc

Browse Source 
* Improve CONTRIBUTING doc

* Correct some typos and grammar errors

* Improve docs/README.md
This commit is contained in:
Joshua 2017-10-26 14:36:13 +08:00 committed by Allen
parent 985a1713ae
commit cf142d3b39
2 changed files with 24 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
CONTRIBUTING.md
View File

@ -1,21 +1,22 @@
# Contributing
# Issues
Before opening an issue, please make sure your problem/request doesn't exist. When you open issue, please provide the following information if possible:
Before opening an issue, please make sure your problem or request doesn't exist. When opening an issue, please provide the following information if possible:
* Example code or repo (please keep it simple and minimal)
* Steps to reproduce
* `react-bootstrap-table2` version
* Steps to reproduce.
* `react-bootstrap-table2` version.
Anyway, you're welcome to open an issue to ask questions or discuss about a feature request.
Additionally, asking questions and requesting new features are welcomed via [issue tracker](https://github.com/react-bootstrap-table/react-bootstrap-table2/issues).
# Pull Requests
Check [here](./docs/development.md) for getting started with development.
* When you want to implement a new feature, please let us know (via issues).
* Please run tests before opening a PR and also remember to test the actual business logic.
* If your PR is trying to fix a bug, please describe the bug number with hashtag when creating the PR.
* We recommend filing an [issue](https://github.com/react-bootstrap-table/react-bootstrap-table2/issues) before you implement any new features.
* Please ensure that all the test suites have passed before submitting a PR. Besides, always test the actual business logic.
* If your PR is trying to fix a bug, please describe the details as much as you could and tag the bug number with hashtag.
# For the members of react-bootstrap-table2 org
* Please convert the ticket to issue when is ticket moved from `Backlog` to `Ready` in project.
* Please write documentation if any new API/feature/props is changed or added.
* Please add a story example if any new feature is implemented
* Please convert the ticket to issue when the ticket has moved from `Backlog` to `Ready`.
* Please update the docs if any API, feature or component props was changed or added. The code and docs should always be in sync.
* Please add a story example if any new feature was implemented.

24
docs/README.md
View File

@ -1,6 +1,6 @@
# Documents
# Documentation
## Props on BootstrapTable
## BootstrapTable Props
#### Required
* [keyField (**required**)](#keyField)
@ -17,28 +17,28 @@
* [selectRow](#selectRow)
### <a name='keyField'>keyField(**required**) - [String]</a>
`keyField` is a prop to tell `react-bootstrap-table2` which column is unigue key.
Tells `react-bootstrap-table2` which column is unique.
### <a name='data'>data(**required**) - [Array]</a>
Assign your table data via `data` prop. It only accept an Array object.
Provides data for your table. It accepts a single Array object.
### <a name='columns'>columns(**required**) - [Object]</a>
`columns` props accept an Array object, please see [columns definition](./columns.md) for more detail.
Accepts a single Array object, please see [columns definition](./columns.md) for more detail.
### <a name='caption'>caption - [String | Node]</a>
Same as [caption tag](https://www.w3schools.com/TAgs/tag_caption.asp) in HTML. You can give a String or a React JSX.
Same as HTML [caption tag](https://www.w3schools.com/TAgs/tag_caption.asp), you can set it as String or a React JSX.
### <a name='striped'>striped - [Bool]</a>
Same as `.table-striped` class for adding zebra-stripes to a table
Same as bootstrap `.table-striped` class for adding zebra-stripes to a table.
### <a name='bordered'>bordered - [Bool]</a>
Same as `.table-bordered` class for adding borders on all sides of the table and cells
Same as bootstrap `.table-bordered` class for adding borders to a table and table cells.
### <a name='hover'>hover - [Bool]</a>
Same as `.table-hover` class for adding a hover effect (grey background color) on table rows
Same as bootstrap `.table-hover` class for adding mouse hover effect (grey background color) on table rows.
### <a name='condensed'>condensed - [Bool]</a>
Same as `.table-condensed` class for makeing a table more compact by cutting cell padding in half
Same as bootstrap `.table-condensed` class for making a table more compact by cutting cell padding in half.
### <a name='cellEdit'>cellEdit - [Object]</a>
`cellEdit` allow you to enable cell editing on table, please see [cellEdit definition](./cell-edit.md) for more detail.
Makes table cells editable, please see [cellEdit definition](./cell-edit.md) for more detail.
### <a name='selectRow'>selectRow - [Object]</a>
`selectRow` allow you to have a mechanism to select rows, please see [selectRow definition](./row-selection.md) for more detail.
Makes table rows selectable, please see [selectRow definition](./row-selection.md) for more detail.