Skip to content

Commit 195d83a

Browse files
committed
Add notice about /public folder
1 parent fd4d41e commit 195d83a

File tree

3 files changed

+35
-31
lines changed

3 files changed

+35
-31
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -85,11 +85,13 @@ Expected file structure:
8585

8686
```md
8787
/snippets
88-
|- language
89-
|- category-name
90-
|- your-snippet-here.md
88+
|- language
89+
|- category-name
90+
|- your-snippet-here.md
9191
```
9292

93+
> Please do **NOT** add or edit anything in `/public` folder. It will be used for consolidating snippets.
94+
9395
### Editing a Existing Snippet
9496

9597
If you’d like to refine or improve an existing snippet:
@@ -122,9 +124,9 @@ contributors: contributor1, contributor2, your-github-username
122124

123125
3. **Document changes:**
124126

125-
Clearly indicate what you updated and why in your pull request description.
127+
- Clearly indicate what you updated and why in your pull request description.
126128

127-
We want to make sure that original author and contributor(s) are credited for their work.
129+
> We want to make sure that original author and contributor(s) are credited for their work.
128130
129131

130132
### Adding a New Category
@@ -145,10 +147,10 @@ Example structure:
145147

146148
```md
147149
/snippets
148-
|- python
149-
|- file-handling
150-
|- list-manipulation
151-
|- ....
150+
|- python
151+
|- file-handling
152+
|- list-manipulation
153+
|- ....
152154
```
153155

154156
### Adding a New Language

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -73,11 +73,13 @@ Expected file structure:
7373

7474
```md
7575
/snippets
76-
|- language
77-
|- category-name
78-
|- your-snippet-here.md
76+
|- language
77+
|- category-name
78+
|- your-snippet-here.md
7979
```
8080

81+
> Please do **NOT** add or edit anything in `/public` folder. It will be used for consolidating snippets.
82+
8183
For more details about adding new categories or programming languages, check out the [CONTRIBUTING.md](/CONTRIBUTING.md) file.
8284

8385
## Guidelines for Contributions

package-lock.json

Lines changed: 19 additions & 19 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)