Skip to content

Commit 401ef23

Browse files
authored
Merge pull request #20 from ahmed33033/12-add-license-contributingmd-and-update-readme
12 add license contributingmd and update readme
2 parents ca03291 + dda6643 commit 401ef23

4 files changed

Lines changed: 731 additions & 61 deletions

File tree

CONTRIBUTING.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Contribute!
2+
3+
There's a variety of ways you can contribute to the dictionary!
4+
5+
## Word of the Day
6+
7+
If you want to suggest a word of the day, simply open up a pull request with an edit to: `lib/term_of_the_day.ts`!
8+
9+
## Add a New Term
10+
11+
If you want to add a new term to the dictionary, open up an issue with the term in the title, and your suggested "General" and "Software" definition in the body of the issue.
12+
13+
Example Issue:
14+
15+
```yml
16+
----------------------------------------
17+
| New Term: Vibe-coding |
18+
|--------------------------------------|
19+
| |
20+
| General definition: .... |
21+
| |
22+
| Software definition: ... |
23+
| |
24+
|--------------------------------------|
25+
```
26+
27+
This will help us open up the floor for discussion, before making a pull request.
28+
29+
## Other Stuff
30+
31+
Just open up an issue with any other suggestions!

0 commit comments

Comments
 (0)