update: small wiki fixes and minor tweaks
This commit is contained in:
6
wiki/contribute/bugs.json
Normal file
6
wiki/contribute/bugs.json
Normal file
@ -0,0 +1,6 @@
|
||||
{
|
||||
"id": "bugs",
|
||||
"title": "Bugs",
|
||||
"author": "ngn",
|
||||
"date": "23/02/24"
|
||||
}
|
||||
26
wiki/contribute/bugs.md
Normal file
26
wiki/contribute/bugs.md
Normal file
@ -0,0 +1,26 @@
|
||||
As an user or a developer, reporting the bugs you find is really important
|
||||
for development of the project. On this page you will find information about how you can report
|
||||
bugs to the project.
|
||||
|
||||
## Package bugs/issues
|
||||
If you are having issues with a package/software, identify the repo contains the package.
|
||||
You can use the `mp-query` command for this.
|
||||
|
||||
After identifying the repo, visit the issue tracker for that specific repo:
|
||||
- [issue tracker for the `base` repo](https://git.matterlinux.xyz/Matter/base/issues)
|
||||
- [issue tracker for the `desktop` repo](https://git.matterlinux.xyz/Matter/desktop/issues)
|
||||
|
||||
Using the search feature of the issue tracker, make sure that the issue has not been already reported.
|
||||
There is no point at reporting the issue, if it has been already reported. Duplicate issues will be closed.
|
||||
|
||||
If the issue has not been already reported, follow the "Registering to Gitea" section of the [contributing page](/wiki/contribute)
|
||||
in order to create an account. Using this account you can create an issue, fill out all the required information,
|
||||
and patiently wait for a response. You should provide additional details about the bug/issue when requested.
|
||||
|
||||
## Tool bugs/issues
|
||||
You may have issues using MatterLinux tools such as the MatterLinux Package Manager (`mp`). This issues should be reported
|
||||
to the related issue tracker over on [Gitea](https://git.matterlinux.xyz/Matter).
|
||||
|
||||
## Translation mistakes, spelling mistakes etc.
|
||||
You do not need to create an issue for small issues such as little translation mistakes. Just contact maintainer/developers
|
||||
on [XMPP](/wiki/chat).
|
||||
6
wiki/contribute/chat.json
Normal file
6
wiki/contribute/chat.json
Normal file
@ -0,0 +1,6 @@
|
||||
{
|
||||
"id": "chat",
|
||||
"title": "Chat",
|
||||
"author": "ngn",
|
||||
"date": "12/01/24"
|
||||
}
|
||||
16
wiki/contribute/chat.md
Normal file
16
wiki/contribute/chat.md
Normal file
@ -0,0 +1,16 @@
|
||||
If you are interested in the project and if you want to meet with other people
|
||||
who are also 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
|
||||
6
wiki/contribute/conduct.json
Normal file
6
wiki/contribute/conduct.json
Normal file
@ -0,0 +1,6 @@
|
||||
{
|
||||
"id": "conduct",
|
||||
"title": "Code of Conduct",
|
||||
"author": "ngn",
|
||||
"date": "12/01/24"
|
||||
}
|
||||
130
wiki/contribute/conduct.md
Normal file
130
wiki/contribute/conduct.md
Normal file
@ -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
|
||||
6
wiki/contribute/contribute.json
Normal file
6
wiki/contribute/contribute.json
Normal file
@ -0,0 +1,6 @@
|
||||
{
|
||||
"id": "contribute",
|
||||
"title": "Contributing",
|
||||
"author": "ngn",
|
||||
"date": "22/02/24"
|
||||
}
|
||||
91
wiki/contribute/contribute.md
Normal file
91
wiki/contribute/contribute.md
Normal file
@ -0,0 +1,91 @@
|
||||
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. You can also contact the maintainer over on [XMPP](/wiki/chat).
|
||||
|
||||
> **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.
|
||||
|
||||
To get more information about reporting bugs, check out [this wiki page](/wiki/bugs).
|
||||
|
||||
## 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.
|
||||
|
||||
> **Important**
|
||||
>
|
||||
> Do not make multiple changes in one commit, for example adding a feature and fixing a bug
|
||||
> in the same commit is a bad idea. Separate different changes to different commits
|
||||
|
||||
**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
|
||||
```
|
||||
|
||||
And here is a more extended configuration for general usage:
|
||||
```
|
||||
set tabstop=2
|
||||
set softtabstop=0
|
||||
set expandtab
|
||||
set shiftwidth=2
|
||||
set smarttab
|
||||
|
||||
set fileencoding="utf-8"
|
||||
set hlsearch
|
||||
set ignorecase
|
||||
set mouse=a
|
||||
set smartcase
|
||||
set smartindent
|
||||
set noswapfile
|
||||
set pumheight=10
|
||||
set undofile
|
||||
set scrolloff=8
|
||||
set sidescrolloff=8
|
||||
set number
|
||||
set relativenumber
|
||||
set backspace=indent,eol,start
|
||||
|
||||
if !isdirectory("/tmp/undos")
|
||||
call mkdir("/tmp/undos", "", 0700)
|
||||
endif
|
||||
set undodir=/tmp/undos
|
||||
set undofile
|
||||
|
||||
syntax on
|
||||
```
|
||||
|
||||
After making the changes, commit them using the following format:
|
||||
```
|
||||
<fix/feature/new/remove/update>: <description>
|
||||
```
|
||||
Do not use long commit messages, instead add a description to your commit if needed. **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.
|
||||
Reference in New Issue
Block a user