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: README.md
+17-82Lines changed: 17 additions & 82 deletions
Original file line number
Diff line number
Diff line change
@@ -12,105 +12,40 @@ An open-source project that categorizes handy code snippets across various progr
12
12
13
13

14
14
15
-
## How to contribute
15
+
## How to Contribute
16
16
17
17
Want to help make QuickSnip even better? You can contribute by:
18
18
19
19
-**Improving the Code**: Fix bugs, suggest new features, or optimize the project.
20
20
-**Adding New Snippets**: Share your favorite snippets to grow the database.
21
21
22
-
Be sure to check out the [CONTRIBUTING.md](/CONTRIBUTING.md) file for detailed guidelines.
22
+
Check out the [CONTRIBUTING.md](/CONTRIBUTING.md) file for detailed contribution guidelines.
23
23
24
-
### Improving the code
24
+
##General Rules
25
25
26
-
-**Reporting bugs**
26
+
To keep everything smooth and consistent, please:
27
27
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.
28
+
-[x] Follow the project’s style and contribution rules.
29
+
-[x] Be kind and respectful to others.
30
+
-[x] If you’re unsure, ask questions.
30
31
31
-
-**Proposing new features**
32
+
Following these rules helps us build an awesome community. 🚀
32
33
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.
34
+
## Third-Party
35
35
36
-
### Adding a Snippet
36
+
We love to see the creativity of our community! If you build something using QuickSnip, let us know. Here are some featured examples:
37
37
38
-
The snippets database is located in the `/snippets` folder.
38
+
- ⚡️ [**Raycast Extension**](https://www.raycast.com/anders_morille/quicksnip): An extension to browse and use QuickSnip snippets directly from Raycast. (Thanks to the creator: [@lille-morille](https://github.com/lille-morille))
39
39
40
-
1. Find the relevant language folder.
40
+
If you’d like to create your own extension or tool:
41
41
42
-
2. Locate the appropriate category folder for your snippet.
42
+
-[x] Please ensure it adheres to our project’s licensing and attribution requirements.
43
+
-[x] Please link to the [original QuickSnip repository](https://github.com/dostonnabotov/quicksnip) in your extension/tool to attribute the source.
44
+
-[x] Share your work with us — we’d be thrilled to feature it!
43
45
44
-
3. Create a markdown file and add your snippet using the following format:
46
+
## Project Vision
45
47
46
-
````md
47
-
---
48
-
title: Name of the snippet
49
-
description: A short explanation of what the snippet does
50
-
tags: tag1, tag2, tag3
51
-
author: your-github-username
52
-
---
53
-
54
-
```lang
55
-
// Your code here
56
-
```
57
-
````
58
-
59
-
Here's an example for JavaScript:
60
-
61
-
````md
62
-
---
63
-
title: Format Date
64
-
description: Formats a date in 'YYYY-MM-DD' format.
0 commit comments