Skip to content

Commit 086c276

Browse files
authored
docs: create CONTRIBUTING.md
1 parent dfa0a7d commit 086c276

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

CONTRIBUTING.md

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Contributing
2+
3+
Hello and welcome! Here are some notes on how to contribute to this repository.
4+
5+
## Prerequisites
6+
7+
This repository aims to depend on as little dependencies as possible to make it simple.
8+
9+
Currently, all that is needed is Python and it's standard library.
10+
11+
## Files
12+
13+
```
14+
.
15+
├── convert_json.py # Converts JSON to RSS
16+
├── convert_readme.py # Converts README into JSON
17+
├── emails.json # Weekly emails in JSON form
18+
├── emails.rss # Weekly emails in RSS form
19+
├── LICENSE
20+
└── README.md # Weekly emails in Markdown form
21+
22+
0 directories, 6 files
23+
```
24+
25+
## Parsing files
26+
27+
There are two Python scripts that help parse and transform the Markdown information:
28+
29+
1. convert_json.py
30+
2. convert_readme.py

0 commit comments

Comments
 (0)