Skip to content

Commit 48a07f1

Browse files
committed
Update guidelines on issues and PRs
1 parent ef1eb88 commit 48a07f1

File tree

2 files changed

+42
-18
lines changed

2 files changed

+42
-18
lines changed

CONTRIBUTING.md

Lines changed: 28 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -11,24 +11,41 @@ You can contribute in two main ways:
1111

1212
## Improving the code
1313

14-
If you have a feature request or want to fix a bug, feel free to:
14+
### How to report bugs
1515

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.
1823

1924
---
2025

2126
## Snippets Guidelines
2227

2328
### Snippet Tags
2429

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`!**
2844

2945
### Snippet Format
3046

3147
**All** snippets should follow the following structure:
48+
3249
- A `code` segment, containing a function with the actual snippet functionnality
3350
- An `example` segement, containing one or more examples of use
3451

@@ -41,17 +58,17 @@ function example(x) {
4158
// Usage:
4259
example(5) // Returns: 10
4360
```
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.
4663

4764
### Snippet boundaries
4865

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:
5067
- **Does the standard library of my language provide an easy way of doing this ?**
5168
- **Does that snippet have a real, and practical use case ?**
5269
- **Could it be split into separate parts to be better understood ?**
5370

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.
5572

5673
---
5774

@@ -230,6 +247,6 @@ If you want to introduce a new programming language, here's how to do it:
230247

231248
Whether you’re fixing a tiny typo, writing a new snippet, or dreaming up big features, every bit counts! 🛠️
232249

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).
234251

235252
Happy coding! 💻✨

README.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,15 @@ Be sure to check out the [CONTRIBUTING.md](/CONTRIBUTING.md) file for detailed g
2323

2424
### Improving the code
2525

26-
Got a feature idea or bug fix? Here's how you can contribute:
26+
- **Reporting bugs**
2727

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.
3035

3136
### Adding a Snippet
3237

@@ -99,11 +104,13 @@ For more details about adding new categories or programming languages, check out
99104

100105
To keep things smooth and consistent, please:
101106

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.
105112

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.**
107114

108115
## License
109116

0 commit comments

Comments
 (0)