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: CODE_OF_CONDUCT.md
-1Lines changed: 0 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -35,4 +35,3 @@ No bots are allowed within the QuickSnip community without prior written permiss
35
35
#### Final Notes
36
36
37
37
This code of conduct is inspired by [FreeCodeCamp’s approach](https://www.freecodecamp.org/news/code-of-conduct), emphasizing clarity and friendliness. Let’s work together to make QuickSnip a supportive and productive space for all developers!
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+56-46Lines changed: 56 additions & 46 deletions
Original file line number
Diff line number
Diff line change
@@ -50,20 +50,22 @@ tags: number,currency
50
50
- An `example` segement, containing one or more examples of use
51
51
52
52
Example in javascript:
53
+
53
54
```js
54
55
functionexample(x) {
55
-
return x *2;
56
+
return x *2;
56
57
}
57
58
58
59
// Usage:
59
-
example(5) // Returns: 10
60
+
example(5);// Returns: 10
60
61
```
61
62
62
63
If your function doesn't return anything just show how to use it. If the result of your function is too complicated to be expressed in a single comment, your snippet is probably too complex to begin with.
63
64
64
65
### Snippet boundaries
65
66
66
67
To ensure your snippet isn’t refused, consider these questions:
68
+
67
69
-**Does the standard library of my language provide an easy way of doing this ?**
68
70
-**Does that snippet not have a real, and practical use case ?**
69
71
-**Could it be split into separate parts to be better understood ?**
@@ -79,23 +81,23 @@ If any answer is yes, then your snippet will most likely get rejected.
79
81
1.**Ensure your snippet match [guidelines](#snippets-guidelines)**
80
82
81
83
2.**Navigate to the relevant folder:**
82
-
83
-
- Go to the `/snippets` folder in the root directory.
84
-
- Locate the folder for the programming language of your snippet, such as `javascript` or `python`.
84
+
85
+
- Go to the `/snippets` folder in the root directory.
86
+
- Locate the folder for the programming language of your snippet, such as `javascript` or `python`.
85
87
86
88
3.**Choose the correct category:**
87
89
88
-
- Within the language folder, find the relevant category folder for your snippet.
89
-
- If no suitable category exists, refer to [Adding a New Category](#adding-a-new-category).
90
+
- Within the language folder, find the relevant category folder for your snippet.
91
+
- If no suitable category exists, refer to [Adding a New Category](#adding-a-new-category).
90
92
91
93
4.**Create a markdown file:**
92
94
93
-
- Create a new file with a `.md` extension.
94
-
- Name the file appropriately, keeping it descriptive and concise.
95
+
- Create a new file with a `.md` extension.
96
+
- Name the file appropriately, keeping it descriptive and concise.
95
97
96
98
5.**Add your snippet:**
97
99
98
-
- Use the following format to structure your snippet:
100
+
- Use the following format to structure your snippet:
0 commit comments