You signed in with another tab or window.Reload to refresh your session.You signed out in another tab or window.Reload to refresh your session.You switched accounts on another tab or window.Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+20-2Lines changed: 20 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,13 +3,16 @@
3
3
>####Table of Contents
4
4
>-[Learning About Tracers](#learning-about-tracers)
5
5
>-[Running on Scratch Paper](#running-on-scratch-paper)
6
+
>-[Directory Structures](#directory-structures)
6
7
>-[Creating a Pull Request](#creating-a-pull-request)
7
8
9
+
Are you a first-timer in contributing to open source?[These guidelines](https://opensource.guide/how-to-contribute/#how-to-submit-a-contribution) from GitHub might help!
10
+
8
11
##Learning About Tracers
9
12
10
13
The project[Algorithm Visualizer](https://github.com/algorithm-visualizer) has a visualization library in each supported language ([JavaScript](https://github.com/algorithm-visualizer/tracers.js),[C++](https://github.com/algorithm-visualizer/tracers.cpp), and[Java](https://github.com/algorithm-visualizer/tracers.java)) to visualize codes.
11
14
12
-
There are five tracers in the library to visualize different types of data.
15
+
There are five tracers in the library to visualize different types of data:
@@ -27,6 +30,21 @@ At the bottom left corner of [algorithm-visualizer.org](https://algorithm-visual
27
30
28
31
We highly encourage you to test your visualization on Scratch Paper several times before creating a pull request.
29
32
33
+
##Directory Structures
34
+
35
+
-**Category A/**
36
+
-**Algorithm A/**
37
+
-**code.js**
38
+
-**code.cpp**
39
+
-**code.java**
40
+
-**README.md**
41
+
-**Algorithm B/**
42
+
-**Algorithm C/**
43
+
- ...
44
+
-**Category B/**
45
+
-**Category C/**
46
+
- ...
47
+
30
48
##Creating a Pull Request
31
49
32
50
1. Fork this repository.
@@ -41,7 +59,7 @@ We highly encourage you to test your visualization on Scratch Paper several time
41
59
42
60
3. Make changes.
43
61
44
-
Understand the[directory structure](https://github.com/algorithm-visualizer/algorithm-visualizer/blob/master/PROJECT_DETAILS.md#algorithms), and create or edit files accordingly.
62
+
Understand the[directory structure](#directory-structures), and create or edit files accordingly.
45
63
46
64
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).