Skip to content

Commit 31070a4

Browse files
committed
Merge README.md into index.md and shorten
Both files contained mostly the same information. This commit merges those into index.md, which is used by the website. This commit shortens the 'wall of text'. By that, some details may be lost. However, in the past years, not all rules were enforced, and this revision does represent the practices from today and combines the ideas from the original document into a structure that is more concise. The idea is to not write down every detail, but to provide a "rule of thumb" - a guideline - for minetest-mods.
1 parent 77ee4fb commit 31070a4

File tree

4 files changed

+117
-156
lines changed

4 files changed

+117
-156
lines changed

.github/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../index.md

README.md

Lines changed: 0 additions & 121 deletions
This file was deleted.

_layouts/default.html

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@
1818
<nav>
1919
<li><a href="{{ page.root }}index.html">Home</a></li>
2020
<li><a href="{{ page.root }}mods.html">Mods</a></li>
21-
<li><a href="{{ page.root }}README.html">Manifest</a></li>
2221
<li><a class="hr"
2322
href="https://github.com/minetest-mods">GitHub</a></li>
2423
<li><a

index.md

Lines changed: 116 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,55 +1,137 @@
1-
---
1+
---
22
title: Welcome
33
layout: default
44
---
55

6-
This project exists to **provide a semi-trusted source of Luanti/Minetest Mods**.
7-
Mods here should be stable (at least in the master branches).
8-
All mods should work well together.
96

10-
## How is a Mod added?
7+
## Introduction
118

12-
The original author of the Mod should be the one submitting it to the minetest-mods
13-
project. Under circumstances (abandoned, author not responsive etc.) we will consider
14-
forks. To submit your project to be added and become the maintainer of a project, submit
15-
a new github issue.
9+
This project exists to **provide a semi-trusted source of Luanti/Minetest mods**.
10+
The mod repositories are primarily developed by their author(s), or are taken care of
11+
by the community, managed by the admins.
1612

17-
In your request, please provide the following information:
13+
### General rules
1814

19-
* your mod name
20-
* author (github username)
21-
* the license(s) of your mod
15+
* Keep the `master` branch stable as possible.
16+
* Keep the mods in a usable and secure (maintained) state.
17+
* Behave and respect each other.
18+
19+
## Roles
20+
21+
### 1. Organisation administrator
22+
23+
Brief: _Keeps an eye on all repositories, and manages them._
24+
25+
**Privileges:**
26+
27+
* Has full access to all minetest-mods repositories, which includes:
28+
* Repository creation and deletion
29+
* Access/permission management
30+
* Modifying content and managing user contributions (patches, issues, PRs)
31+
32+
**Duties:**
33+
34+
* Must respect the decisions of the mod author.
35+
* Must obtain a decision from the mod author (if active) before deciding on their own.
36+
* Ensures that the mod requirements are met (section "How to add a mod?").
37+
* Is in charge to resolve security-related topics.
38+
39+
### 2. Mod author
40+
41+
Brief: _Develops their mod, with or without external contributions._
42+
43+
**Privileges:**
44+
45+
* Has full access to their mod repository, which includes:
46+
* Access/permission management (e.g. co-authorship)
47+
* Modifying content and managing user contributions (patches, issues, PRs)
48+
* If any action cannot be performed due to technical limitations - e.g. repository removal -
49+
the task shall be done by an admin.
50+
51+
**Duties:**
52+
53+
* Unless communicated explicitly, the mod author permits the community to maintain their
54+
project, managed by the co-authors or organisation admins.
55+
* Ensures proper functionality of the mod.
56+
57+
### 3. Individual contributor
2258

23-
By submitting a project, you acknowledge that you agree to the rules in the [manifest](README.html)
59+
Brief: _Contributes to mods within the organisation._
2460

25-
Click here: [Open Request](https://github.com/minetest-mods/minetest-mods.github.io/issues/new?title=New%20mod%20request)
61+
**Privileges:**
2662

27-
After opening a request ticket, you will be asked to initiate a "Transfer" request to move your mod. If you want to fork your moved repository back, you are obviously free to do so. You will be granted admin access on the moved repository. More information on the "Transfer" procedure can be found here: [Transfer Information](https://help.github.com/articles/transferring-a-repository/)
63+
* May propose commits, PRs, and submit issues.
64+
* May have limited access to mod repositories - granted by mod authors or admins.
2865

29-
We also send all mod owners a "become a member of minetest-mods" invitation. This invitation does not need to be accepted, and is merely for you (and us) to show who is participating in the minetest-mods organization. You do not require the invite. If you missed it, and would still like to become a listed member, please request another invitation.
66+
**Duties:**
67+
68+
* Must respect the decisions of the mod author.
69+
70+
## How to add a mod?
71+
72+
Mods added to this organisation must follow a few minimal requirements, which are listed below.
73+
74+
### Requirements
75+
76+
**Ownership**
77+
78+
* The original author of the mod should be the one submitting it to the minetest-mods
79+
organisation.
80+
* Under circumstances (abandoned by author) we will consider
81+
forks.
82+
83+
**Licensing**
84+
85+
* An OSI-approved license is strongly preferred.
86+
* Mods do not need to be Luanti-licensing compatible (meaning, GPL 3.0+ is accepted)
87+
* Public Domain is not defined well in many countries, thus licenses such as
88+
MIT or CC0 should be used. Prefer CC0 over WTFPL.
89+
90+
**Mod structure**
91+
92+
* Required
93+
* A clear statement on the code and media licensing
94+
* A `mod.conf` file
95+
* Strongly recommended
96+
* Screenshot
97+
* Matching LICENSE files
98+
99+
**Mod name**
100+
101+
Many mods have similar names but sometimes provide very different functionality.
102+
For the purpose of clarity, conflicting names are to be prevented.
103+
Repositories in the minetest-mods organisation should have clear and unambiguous
104+
names.
105+
106+
### Submitting
107+
108+
In your request, please provide the following information:
109+
110+
* your mod name
111+
* author (GitHub username, if available)
112+
* the license(s) of your mod
30113

31-
## Can any Luanti mod be added?
114+
By submitting a project, you acknowledge that you agree to the rules specified in this document.
32115

33-
* Mods should preferrably be licensed under an OSI approved license.
34-
* Mods do not need to be minetest-licensing compatible (meaning, GPL3.0+ is fine)
35-
* Non-OSI licenses may be acceptable.
36-
* Public Domain is not defined well in many countries, so licenses such as WTFPL,
37-
MIT or CC0 should be used.
116+
* [Open Request (GitHub)](https://github.com/minetest-mods/minetest-mods.github.io/issues/new?title=New%20mod%20request) (preferred)
117+
* [Open Request (Luanti Forums)](https://forum.luanti.org/viewtopic.php?t=13839) (alternative)
38118

39-
## What's in it for users?
119+
### Repository transfer
40120

41-
* A central place to find well-maintained mods.
42-
* Clarity as to which fork is the recommended version of a mod.
43-
* Well-defined mods with proper metadata that work without renaming and installation issues.
44-
* The security of knowing many more developers are looking at mod code than just one person.
121+
After opening a request ticket, you will be asked to initiate a "Transfer" request to move your mod.
122+
If you want to fork your moved repository back, you are obviously free to do so.
123+
You will be granted admin access on the moved repository. More information on the "Transfer" procedure
124+
can be found here: [Transfer Information](https://help.github.com/articles/transferring-a-repository/)
45125

46-
## What's in it for developers?
47-
* Knowing that they can take a break from Luanti when they need or choose to, and that someone will be capable of taking care of their mods.
48-
* A large group of experienced mod developers that are willing to help out improve their code.
49-
* More users looking at their mods and better exposure.
126+
We also send all mod owners a "become a member of minetest-mods" invitation.
127+
This invitation does not need to be accepted, and is merely for you (and us)
128+
to show who is participating in the minetest-mods organisation.
129+
You do not require the invite. If you missed it, and would still like to become a listed member,
130+
please request another invitation.
50131

51132
## Got any more questions?
52133

53-
Read [our full manifest](README.html).
134+
Read the informal [forum announcement post](https://forum.luanti.org/viewtopic.php?t=13839),
135+
and leave feedback or join the discussion.
54136

55-
Alternatively, read the informal [forum announcement post](https://forum.luanti.org/viewtopic.php?t=13839), and leave feedback or join the discussion.
137+
Request a clarification of the rules stated above: [Open Request (GitHub)](https://github.com/minetest-mods/minetest-mods.github.io/issues/new).

0 commit comments

Comments
 (0)