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
+28-11Lines changed: 28 additions & 11 deletions
Original file line number
Diff line number
Diff line change
@@ -11,24 +11,41 @@ You can contribute in two main ways:
11
11
12
12
## Improving the code
13
13
14
-
If you have a feature request or want to fix a bug, feel free to:
14
+
### How to report bugs
15
15
16
-
-[Open an Issue](https://github.com/dostonnabotov/quicksnip/issues) to let us know what’s up.
17
-
-[Send a Pull Request](https://github.com/dostonnabotov/quicksnip/pulls) with your changes.
16
+
If you spot a bug in the codebase or issues with the documentation, please open up a [GitHub issue](https://github.com/dostonnabotov/quicksnip/issues) detailing the problem before creating a PR. Once confirmed with maintainers, you can then create a PR.
17
+
18
+
### How to propose new features
19
+
20
+
If you are interested in proposing new features, please open up a new [GitHub discussion](https://github.com/dostonnabotov/quicksnip/discussions) with details for the proposed feature.
21
+
22
+
Please do not create a PR for a new feature without first discussing it with the maintainers. If you create a PR for a new feature without discussing it first, then your PR will be closed.
18
23
19
24
---
20
25
21
26
## Snippets Guidelines
22
27
23
28
### Snippet Tags
24
29
25
-
Tags must describe the snippet with simple word. \
26
-
For example a snippet that capitalize a word would have `string` and `capitalize` as tags. \
27
-
**! Do not add the language you are using as a tag, nor some generic keyword like `utility` !**
30
+
- Tags must describe the snippet with simple word.
31
+
32
+
Here's an example:
33
+
34
+
```md
35
+
---
36
+
title: Convert Number to Currency
37
+
description: Converts a number to a currency format with a specific locale.
38
+
author: axorax
39
+
tags: number,currency
40
+
---
41
+
```
42
+
43
+
**Do not use generic keywords or the language itself as a tag `utility` or `javascript`!**
28
44
29
45
### Snippet Format
30
46
31
47
**All** snippets should follow the following structure:
48
+
32
49
- A `code` segment, containing a function with the actual snippet functionnality
33
50
- An `example` segement, containing one or more examples of use
34
51
@@ -41,17 +58,17 @@ function example(x) {
41
58
// Usage:
42
59
example(5) // Returns: 10
43
60
```
44
-
If your function doesn't return anything just show how to use it. \
45
-
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.
61
+
62
+
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.
46
63
47
64
### Snippet boundaries
48
65
49
-
To **check if your snippet will not get refused** ask yourself those questions:
66
+
To ensure your snippet isn’t refused, consider these questions:
50
67
-**Does the standard library of my language provide an easy way of doing this ?**
51
68
-**Does that snippet have a real, and practical use case ?**
52
69
-**Could it be split into separate parts to be better understood ?**
53
70
54
-
If one of question is true, then your snippet will most likely get refused !
71
+
If any answer is yes, then your snippet will most likely get rejected.
55
72
56
73
---
57
74
@@ -230,6 +247,6 @@ If you want to introduce a new programming language, here's how to do it:
230
247
231
248
Whether you’re fixing a tiny typo, writing a new snippet, or dreaming up big features, every bit counts! 🛠️
232
249
233
-
If you have any questions or need help, feel free to open an issue or tag me.
250
+
If you have any questions or need help, feel free to open a new [GitHub discussion](https://github.com/dostonnabotov/quicksnip/discussions).
Copy file name to clipboardExpand all lines: README.md
+14-7Lines changed: 14 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -23,10 +23,15 @@ Be sure to check out the [CONTRIBUTING.md](/CONTRIBUTING.md) file for detailed g
23
23
24
24
### Improving the code
25
25
26
-
Got a feature idea or bug fix? Here's how you can contribute:
26
+
-**Reporting bugs**
27
27
28
-
-[Open an issue](https://github.com/dostonnabotov/quicksnip/issues) to share your ideas or report a bug.
29
-
-[Send a pull request](https://github.com/dostonnabotov/quicksnip/pulls) with your changes.
28
+
- If you spot a bug in the codebase or issues with the documentation, please open up a [GitHub issue](https://github.com/dostonnabotov/quicksnip/issues) detailing the problem before creating a PR.
29
+
- Once confirmed with maintainers, you can then create a PR.
30
+
31
+
-**Proposing new features**
32
+
33
+
- If you are interested in proposing new features, please open up a new [GitHub discussion](https://github.com/dostonnabotov/quicksnip/discussions) with details for the proposed feature.
34
+
- Please do **not** create a PR for a new feature without first discussing it with the maintainers. If you create a PR for a new feature without discussing it first, then your PR will be closed.
30
35
31
36
### Adding a Snippet
32
37
@@ -99,11 +104,13 @@ For more details about adding new categories or programming languages, check out
99
104
100
105
To keep things smooth and consistent, please:
101
106
102
-
- Follow the formatting rules described above.
103
-
- Include all mandatory fields in the snippet.
104
-
- Test your snippet to ensure it works as expected.
107
+
-[x] Follow the style and contribution guidelines of this project.
108
+
-[x] Include all mandatory fields in the snippet.
109
+
-[x] Test your snippet to ensure it works as expected.
110
+
111
+
Following these guidelines helps us (and everyone else) review and merge your contributions faster.
105
112
106
-
Following these guidelines helps me (and everyone else) review and merge your contributions faster.
113
+
**If you fail to meet the guidelines, your PR will most likely get rejected.**
0 commit comments