1 | # Contributing to Recharts
|
2 |
|
3 | We'd love for you to contribute to our source code and to make Recharts even better than it is today! Here are the guidelines we'd like you to follow:
|
4 |
|
5 | - [Issues and Bugs](#issues)
|
6 | - [Testing](#testing)
|
7 | - [Pull Requests](#pr)
|
8 | - [Code Guide](#code)
|
9 | - [License](#license)
|
10 |
|
11 | ## Ongoing Initiatives
|
12 |
|
13 | We use Github Discussion to organize our discussion along new initiatives and organize ourselves. Please do check the [announcements](https://github.com/recharts/recharts/discussions/categories/announcements) section for an overview of recent initiatives.
|
14 |
|
15 | ## <a name="issues"></a>Issues and Bugs
|
16 |
|
17 | ### Where to Find Known Issues
|
18 |
|
19 | We will be using [GitHub Issues](https://github.com/recharts/recharts/issues) for our bugs and feature requests. We will keep a close eye on this and try to make it clear when we have an internal fix in progress. Before filing a new task, try to make sure your problem doesn't already exist.
|
20 |
|
21 | ### Reporting New Issues
|
22 |
|
23 | The best way to get your bug fixed is to provide a reduced test case. codesandbox provide a way to give live examples. You can fork our example in [recharts.org](http://recharts.org/) to show your case.
|
24 |
|
25 | ## <a name="testing"></a>Testing
|
26 |
|
27 | We do cherish tests. They help us move swiftly, and release with confidence.
|
28 | In our repo, you will find three types of tests: Unit tests, rendering tests with RTL, and user interaction tests in storybook.
|
29 | Wherever possible we prefer the simplest tests - unit tests. Only where needed / useful we would use RTL or storybook tests.
|
30 |
|
31 | ### Unit tests
|
32 |
|
33 | When implementing a new feature we would prefer to extract pure helper function for data processing. Such functions are found a few utils files. An example is `test/util/ShallowEqual.spec.ts`
|
34 |
|
35 | ### React Testing Library
|
36 |
|
37 | Some behaviour must be tested upon rendering, such as interactions between components (Line, Tooltip), see `test/component/Tooltip.spec.tsx` for an example.
|
38 |
|
39 | ### Storybook Test Runner
|
40 |
|
41 | Storybook also has a great interface for adding tests. By default every story in storybook is a smoke test (rendering without error logs means the test passed). Additionally, it is possible to add actual tests as play functions with an assert to a story. This will often be easier than using React Testing Library, because the natural test debugging tool is Storybook itself. See for example `storybook/stories/Examples/cartesian/ReferenceLine/ReferenceLineIfOverflow.stories.tsx`
|
42 |
|
43 | ### Performance tests
|
44 |
|
45 | Recharts uses (https://callstack.github.io/reassure/)[Reassure] to run performance tests. Here is how to use:
|
46 |
|
47 | 1. Before making code changes, run `npm run test:perf:baseline`. This will generate baseline data. You only do this once for each change.
|
48 | 2. Make your code changes now
|
49 | 3. Run `npm test:perf`. Reassure will run tests again, compare with the baseline from step 1. and print results to the console. If you wish you can also review the results in a markdown file in path `./reassure/output.md`.
|
50 | 4. If you are satisfied with the performance impact then go ahead and commit! If you wish to make more changes go back to step 2.
|
51 |
|
52 | Reassure will look for `*.perf-test.tsx` files by default.
|
53 |
|
54 | Also be aware that the performance tests might take a long time to run; up to several minutes.
|
55 |
|
56 | ## <a name="pr"></a>Pull Requests
|
57 |
|
58 | **Working on your first Pull Request?** You can learn how from this _free_ series [How to Contribute to an Open Source Project on GitHub](https://app.egghead.io/playlists/how-to-contribute-to-an-open-source-project-on-github)
|
59 |
|
60 | _Before_ submitting a pull request, please make sure the following is done…
|
61 |
|
62 | - Search [GitHub](https://github.com/recharts/recharts/pulls) for an open or closed Pull Request that relates to your submission. You don't want to duplicate effort.
|
63 |
|
64 | - Fork the repo and create your branch from `master`.
|
65 | - If you have added functionality or changed existing functionality, be sure to add a test. Ideally a unit test for helper function, or a test that includes rendering with RTL.
|
66 | - If you've changed APIs, make sure that the stories in Storybook are working as expected.
|
67 | - Ensure the test suite passes (`npm run test`).
|
68 | - Make sure your code lints (`npm run lint`) - we've done our best to make sure these rules match our internal linting guidelines.
|
69 |
|
70 | ## <a name="code"></a>Code Guide
|
71 |
|
72 | Our linter will catch most styling issues that may exist in your code.
|
73 | You can check the status of your code styling by running: `npm run lint`
|
74 |
|
75 | However, there are still some styles that the linter cannot pick up. If you are unsure about something, looking at [Airbnb's Style Guide](https://github.com/airbnb/javascript) will guide you in the right direction.
|
76 |
|
77 | ## <a name="license"></a>License
|
78 |
|
79 | By contributing to Recharts, you agree that your contributions will be licensed under its MIT license.
|