|
| 1 | +# Contributing |
| 2 | + |
| 3 | +> #### Table of Contents |
| 4 | +> - [Learning About Tracers](#learning-about-tracers) |
| 5 | +> - [Running on Scratch Paper](#running-on-scratch-paper) |
| 6 | +> - [Creating a Pull Request](#creating-a-pull-request) |
| 7 | +
|
| 8 | +## Learning About Tracers |
| 9 | + |
| 10 | +[`tracers`](https://github.com/algorithm-visualizer/tracers) is the visualization library we use to visualize codes. |
| 11 | + |
| 12 | +There are five tracers in the library to visualize different types of data. |
| 13 | + |
| 14 | +- [Array1DTracer](https://github.com/algorithm-visualizer/tracers/wiki/Array1DTracer) |
| 15 | +- [Array2DTracer](https://github.com/algorithm-visualizer/tracers/wiki/Array2DTracer) |
| 16 | +- [ChartTracer](https://github.com/algorithm-visualizer/tracers/wiki/ChartTracer) |
| 17 | +- [GraphTracer](https://github.com/algorithm-visualizer/tracers/wiki/GraphTracer) |
| 18 | +- [LogTracer](https://github.com/algorithm-visualizer/tracers/wiki/LogTracer) |
| 19 | + |
| 20 | +There are also randomizers to help you create random data. |
| 21 | + |
| 22 | +Visit the [wiki](https://github.com/algorithm-visualizer/tracers/wiki) in [`tracers`](https://github.com/algorithm-visualizer/tracers) repo for more information. |
| 23 | + |
| 24 | +## Running on Scratch Paper |
| 25 | + |
| 26 | +At the bottom left corner of [algorithm-visualizer.org](https://algorithm-visualizer.org/), there is Scratch Paper where you can visualize your own code. |
| 27 | + |
| 28 | +We highly encourage you to test your visualization on Scratch Paper several times before creating a pull request. |
| 29 | + |
| 30 | +## Creating a Pull Request |
| 31 | + |
| 32 | +1. Fork this repository. |
| 33 | + |
| 34 | +  |
| 35 | + > 'Fork' button is at the top right corner of this page. |
| 36 | +
|
| 37 | +2. Create a branch named the algorithm you'd like to add/improve. |
| 38 | + |
| 39 | +  |
| 40 | + > 'Branch' button is below the header of your forked repository. |
| 41 | + |
| 42 | +3. Make changes. |
| 43 | + |
| 44 | + Understand the [directory structure](https://github.com/algorithm-visualizer/algorithm-visualizer/blob/master/PROJECT_DETAILS.md#algorithms), and create or edit files accordingly. |
| 45 | + |
| 46 | + If you want to create a directory, check out this [Stack Overflow answer](https://stackoverflow.com/questions/18773598/creating-folders-inside-github-com-repo-without-using-git). |
| 47 | + |
| 48 | +  |
| 49 | + > Input a commit message addressing your changes, and make sure you are committing to the branch you created. |
| 50 | +
|
| 51 | +4. Create a pull request. |
| 52 | + |
| 53 | +  |
| 54 | + > 'Compare & pull request' button is below the header of the main page of your forked repository. |
| 55 | +
|
| 56 | +  |
| 57 | + > Make sure you are merging to `algorithm-visualizer/algorithms`'s `master` branch from your forked repository's branch you created. |
| 58 | + |
| 59 | +5. Thanks for your contribution! Once we review and merge your pull request, your changes will be reflected on [algorithm-visualizer.org](https://algorithm-visualizer.org/). |
0 commit comments