Skip to content

Commit 5208092

Browse files
committed
Update Contribution Guide
1 parent d61b8e3 commit 5208092

File tree

2 files changed

+34
-25
lines changed

2 files changed

+34
-25
lines changed

CONTRIBUTING.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Contribution Guidelines
2+
3+
If you want to help out and contribute to this filetree, please follow this basic flow:
4+
5+
6+
7+
- fork this project
8+
9+
* start within the *root* directory → `/root`
10+
11+
* create/extends the folder structure → e.g. `/root/foo/bar`
12+
13+
* make sure the deeply nested folder contains at least one placeholder file →
14+
15+
`/root/foo/bar/example.doc`
16+
17+
* add notes with markdown → `README.md` / `notes.md` / `media.md`
18+
19+
* If your are confident with the changes, create a pull request
20+
21+
into the `wip` (Work-In-Progress) branch.
22+
23+
* If you just want to share your personal filetree,
24+
25+
please create a new branch on your fork with this pattern: `user/nickname`
26+
27+
28+
29+
------
30+
31+
32+
33+
We also welcome any discussion in the *issues* section. Feel free to open a new issue if you see something missing or an error. You can also help discuss uncertain topics and contribute by posting your opinion on certain structures/namings/etc.
34+

README.md

Lines changed: 0 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -15,29 +15,4 @@ We aim to create a unified filetree for all kinds of data.
1515

1616
* [Universal Decimal Classification](https://en.wikipedia.org/wiki/Universal_Decimal_Classification)
1717

18-
19-
20-
## Notes for Contributors
21-
22-
- If your are confident with the changes,
23-
24-
push changes into the `wip` (Work-In-Progress) branch.
25-
26-
- If you want to share your personal filetree,
27-
28-
create your own user-branch: `user/nickname`
29-
30-
31-
32-
**Basic Guidelines:**
33-
34-
* start with a *root* directory (`/root`)
35-
36-
* create your folder structure (e.g. `/root/foo/bar`)
37-
38-
* make sure the deeply nested folder contains at least one placeholder file:
39-
40-
`/root/foo/bar/example.doc`
41-
42-
* add notes with markdown → `README.md` / `notes.md` / `media.md`
4318

0 commit comments

Comments
 (0)