mirror of
https://github.com/gosticks/react-table.git
synced 2025-10-16 11:55:36 +00:00
d2acfc4235
* size-snapshot created? * Added docz for documentation site * Modified .gitignore to get rid of .docz internal stuff * Update all doc links to point to proper paths with docz * Removed .docz folder from Git Co-authored-by: Jason Clark <jason.clark@tcnbroadcasting.com>
34 lines
1.7 KiB
Markdown
34 lines
1.7 KiB
Markdown
---
|
|
name: Contributing
|
|
route: /contributing
|
|
---
|
|
|
|
# Contributing
|
|
|
|
## Questions
|
|
|
|
If you have questions about implementation details, help or support, then please use our dedicated community forum at [Github Discussions](https://github.com/tannerlinsley/react-table/discussions) **PLEASE NOTE:** If you choose to instead open an issue for your question, your issue will be immediately closed and redirected to the forum.
|
|
|
|
## Reporting Issues
|
|
|
|
If you have found what you think is a bug, please [file an issue](https://github.com/tannerlinsley/react-table/issues/new). **PLEASE NOTE:** Issues that are identified as implementation questions or non-issues will be immediately closed and redirected to [Github Discussions](https://github.com/tannerlinsley/react-table/discussions)
|
|
|
|
## Suggesting new features
|
|
|
|
If you are here to suggest a feature, first create an issue if it does not already exist. From there, we will discuss use-cases for the feature and then finally discuss how it could be implemented.
|
|
|
|
## Development
|
|
|
|
If you have been assigned to fix an issue or develop a new feature, please follow these steps to get started:
|
|
|
|
- Fork this repository
|
|
- Install dependencies by running `$ yarn`
|
|
- Link `react-table` locally by running `$ yarn link`
|
|
- Auto-build files as you edit by running `$ yarn start`
|
|
- Implement your changes and tests to files in the `src/` directory and corresponding test files
|
|
- To run examples, follow their individual directions. Usually this is just `$ yarn && yarn start`.
|
|
- To run examples using your local build, link to the local `react-table` by running `$ yarn link react-table` from the example's directory
|
|
- Document your changes in the appropriate doc page
|
|
- To stage a commit, run `yarn commit`
|
|
- Submit PR for review
|