From 9a0ff7e2718bfe403eb35ccc4bc44e04d0dd8f3e Mon Sep 17 00:00:00 2001 From: ngn Date: Fri, 12 Jan 2024 19:46:03 +0300 Subject: [PATCH] MORE PAGES --- index.md | 4 +- wiki/chat.json | 6 ++ wiki/chat.md | 16 ++++++ wiki/conduct.json | 6 ++ wiki/conduct.md | 130 +++++++++++++++++++++++++++++++++++++++++++ wiki/contribute.json | 6 ++ wiki/contribute.md | 47 ++++++++++++++++ wiki/licensing.json | 6 ++ wiki/licensing.md | 16 ++++++ wiki/main.md | 9 ++- 10 files changed, 239 insertions(+), 7 deletions(-) create mode 100644 wiki/chat.json create mode 100644 wiki/chat.md create mode 100644 wiki/conduct.json create mode 100644 wiki/conduct.md create mode 100644 wiki/contribute.json create mode 100644 wiki/contribute.md create mode 100644 wiki/licensing.json create mode 100644 wiki/licensing.md diff --git a/index.md b/index.md index be87300..b345896 100644 --- a/index.md +++ b/index.md @@ -25,5 +25,5 @@ Currently active contributors are: - (Maintainer) [ngn](mailto:ngn13proton@proton.me) Consider helping out if you are interested in this project. -To do so, join [matterlinux@conference.jabbers.one](xmpp:matterlinux@conference.jabbers.one?join) -to request an account for the git server. You can also send an email to the maintainer. +To do so, check out the [contribution guide](/wiki/contribute). If have any questions/problems +feel free to join the [chat rooms](/wiki/chat) and ask questions you have to the maintainer/developers. diff --git a/wiki/chat.json b/wiki/chat.json new file mode 100644 index 0000000..3250fc1 --- /dev/null +++ b/wiki/chat.json @@ -0,0 +1,6 @@ +{ + "id": "chat", + "title": "Chat", + "author": "ngn", + "date": "12/01/24" +} diff --git a/wiki/chat.md b/wiki/chat.md new file mode 100644 index 0000000..c675986 --- /dev/null +++ b/wiki/chat.md @@ -0,0 +1,16 @@ +If you are interested in the project and if you want to meet with other people +who are interested, feel free to join any of the chat rooms on the table: + +| Platform | Admin | Topic | Language | Link | +| ------------- | ------------------------ | -------------------------- | ------------- | ------- | +| XMPP | [ngn](mailto:ngn@ngn.tf) | Development and questions | English | [general@conf.matterlinux.xyz](xmpp:general@conf.matterlinux.xyz?join) | + +## Rules +Here are the rules for all the chat rooms: + +1. Stay on the topic. +2. Be respectful to others. +3. No spam. +4. No advertising. +5. No NSFW/NSFL content. +6. Only chat in the specified language. diff --git a/wiki/conduct.json b/wiki/conduct.json new file mode 100644 index 0000000..6c73b09 --- /dev/null +++ b/wiki/conduct.json @@ -0,0 +1,6 @@ +{ + "id": "conduct", + "title": "Code of Conduct", + "author": "ngn", + "date": "12/01/24" +} diff --git a/wiki/conduct.md b/wiki/conduct.md new file mode 100644 index 0000000..1639983 --- /dev/null +++ b/wiki/conduct.md @@ -0,0 +1,130 @@ +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, caste, color, religion, or sexual +identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the overall + community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or advances of + any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email address, + without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official email address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +[git.matterlinux.xyz](https://git.matterlinux.xyz/). +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series of +actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or permanent +ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within the +community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.1, available at +[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. + +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder][Mozilla CoC]. + +For answers to common questions about this code of conduct, see the FAQ at +[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at +[https://www.contributor-covenant.org/translations][translations]. + +[homepage]: https://www.contributor-covenant.org +[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html +[Mozilla CoC]: https://github.com/mozilla/diversity +[FAQ]: https://www.contributor-covenant.org/faq +[translations]: https://www.contributor-covenant.org/translations diff --git a/wiki/contribute.json b/wiki/contribute.json new file mode 100644 index 0000000..f858245 --- /dev/null +++ b/wiki/contribute.json @@ -0,0 +1,6 @@ +{ + "id": "contribute", + "title": "Contributing", + "author": "ngn", + "date": "12/01/24" +} diff --git a/wiki/contribute.md b/wiki/contribute.md new file mode 100644 index 0000000..833ffee --- /dev/null +++ b/wiki/contribute.md @@ -0,0 +1,47 @@ +If you want to contribute to MatterLinux, please first read the +[code of conduct](/wiki/conduct). + +## Registering to Gitea +All of the development is done using the [git version control system](https://git-scm.com/). +And all the git repos are managed using [Gitea](https://about.gitea.com/), so if you want to +contribute, you should register an account first. To prevent mass account creation, registration +page of Gitea is disabled. So in order to register an account, send a email to the +[maintainer](mailto:ngn@ngn.tf) with the subject `Gitea Account`. Specify **at least** two usernames +for your account (second one will be used for registration if the first one is unavailable). Then +wait for a reply containing further instructions. + +**Important:** Do not use the Gitea instance for hosting your own projects/repositories, personal +repositories (A.K.A. repositories not forked for PRs) will be deleted. If you insist on creating +personal repositories your account will be deleted. + +## Issues +To report a bug, to ask questions or to request a feature, first find the related repository. +Then head over to the issue tab. Label your issue and explain it with a simple title. Write a +detailed description for the issue. Finally create the issue and patiently wait for a response. + +## Pull Requests +If you want to make changes and merge them to the project, first fork the related repository. +Then clone the forked repository and make the changes you want. + +**Make sure to use correct indenting!**. MatterLinux projects uses **2 spaces** for indenting. +Configure your editor so it uses the same indenting. Here is an example configuration for the +`vim` editor: +``` +set tabstop=2 +set softtabstop=0 +set expandtab +set shiftwidth=2 +set smarttab +``` + +After making the changes, commit them with a descriptive message. Do not use long commit messages, +instead add a description to your commit. **Make sure the email you are using for signing the +commit matches with your Gitea account email.** + +After pushing your changes create a pull request (PR) to the original project. Write a +detailed description for the PR, explain the changes you have made, explain why you made +these changes and link any related issues. + +## Discussion +Join the [chat rooms](/wiki/chat) to discuss with the other developers, especially for larger +changes and PRs. diff --git a/wiki/licensing.json b/wiki/licensing.json new file mode 100644 index 0000000..06e3023 --- /dev/null +++ b/wiki/licensing.json @@ -0,0 +1,6 @@ +{ + "id": "licensing", + "title": "Licensing", + "author": "ngn", + "date": "12/01/24" +} diff --git a/wiki/licensing.md b/wiki/licensing.md new file mode 100644 index 0000000..20efaee --- /dev/null +++ b/wiki/licensing.md @@ -0,0 +1,16 @@ +## License +All of the MatterLinux software and the tools are available on +[MatterLinux Git Server](https://git.matterlinux.xyz) and they are licensed under +[GNU General Public License Version 3](https://www.gnu.org/licenses/gpl-3.0.en.html). +A copy of this license can be found in every repository, in the `LICENSE.txt` file. + +MatterLinux software and the tools are distributed as [free/libre](https://www.gnu.org/philosophy/free-sw.en.html) and +[open source](https://opensource.com/resources/what-open-source) software. This means anybody can: + +- Use MatterLinux software and tools +- Distribute copies of MatterLinux software and tools +- Modify MatterLinux software and tools +- Distribute modified copies of MatterLinux software and tools + +## Trademarks & Copyrights +Currently, MatterLinux project do **not** have a registered copyright or a trademark. diff --git a/wiki/main.md b/wiki/main.md index ebc1552..0947b0b 100644 --- a/wiki/main.md +++ b/wiki/main.md @@ -1,5 +1,5 @@ You can use this page as a catalog, it will let you discover other pages. If you want to -edit a page or create a new page, make a pull-request to [content](https://git.matterlinux.xyz/matter/content) repository. +edit a page or create a new page, make a [pull request](/wiki/contribute) to [content](https://git.matterlinux.xyz/matter/content) repository. **Important:** Wiki is currently under development, so some of the pages on the tables don't have a link yet. @@ -23,7 +23,6 @@ don't have a link yet. ## Other | Name | Description | | -------------------------------- | ------------------------------------------------------- | -| Bugs and Issues | Learn how you can report bugs and issues to developers | -| Contributing | Learn how you can contribute to MatterLinux | -| Contact | Learn how you can contact developers and users | -| Licensing | Licensing for the MatterLinux repositories and software | +| [Chat](/wiki/chat) | Learn how you can contact developers and users | +| [Contributing](/wiki/contribute) | Learn how you can contribute to MatterLinux | +| [Licensing](/wiki/licensing) | Licensing for the MatterLinux repositories and software |