From 5d11ac164fffcb4276e6cc26fad4661381a6e297 Mon Sep 17 00:00:00 2001 From: ngn Date: Thu, 22 Aug 2024 00:40:12 +0300 Subject: [PATCH] update: add IRC link to contribution pages --- wiki/contribute/bugs.md | 14 +++++++--- wiki/contribute/chat.md | 9 ++++--- wiki/contribute/contribute.md | 48 ++++++++++++++++++----------------- 3 files changed, 40 insertions(+), 31 deletions(-) diff --git a/wiki/contribute/bugs.md b/wiki/contribute/bugs.md index b8e9def..407ecef 100644 --- a/wiki/contribute/bugs.md +++ b/wiki/contribute/bugs.md @@ -3,12 +3,18 @@ for development of the project. On this page you will find information about how 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. +If you are having issues with a package/software, identify the pool that contains the package. +To do so you can use the following command: +``` +$ matt info +``` +Or you can search for the package using the [MatterLinux package tracker](https://tracker.matterlinux.xyz). 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) +- [issue tracker for the `server` 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. @@ -18,9 +24,9 @@ in order to create an account. Using this account you can create an issue, fill 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 +You may have issues using MatterLinux tools such as the MatterLinux Package Manager (`matt`). 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). +on [directly](/wiki/chat). diff --git a/wiki/contribute/chat.md b/wiki/contribute/chat.md index 4ac588b..fc9b265 100644 --- a/wiki/contribute/chat.md +++ b/wiki/contribute/chat.md @@ -2,15 +2,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 | -| ------------- | ------------------------ | -------------------------- | ------------- | ------- | +| ------------- | ------------------------ | -------------------------- | ------------- | ------- | +| IRC | [ngn](mailto:ngn@ngn.tf) | Development and questions | English | [#matterlinux on libera.chat](irc://libera.chat/#matterlinux) | | XMPP | [ngn](mailto:ngn@ngn.tf) | Development and questions | English | [general@conf.matterlinux.xyz](xmpp:general@conf.matterlinux.xyz?join) | -## Rules +## Rules Here are the rules for all the chat rooms: -1. Stay on the topic +1. Stay on the topic 2. Be respectful to others 3. No spam 4. No advertising -5. No NSFW/NSFL content +5. No inappropriate content 6. Only chat in the specified language diff --git a/wiki/contribute/contribute.md b/wiki/contribute/contribute.md index d176668..78c050e 100644 --- a/wiki/contribute/contribute.md +++ b/wiki/contribute/contribute.md @@ -1,27 +1,27 @@ -If you want to contribute to MatterLinux, please first read the -[code of conduct](/wiki/conduct). +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 +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). +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 [directly](/wiki/chat). -> **Important** +> **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 +> Do not use the Gitea instance for hosting your own projects/repositories, personal +> repositories (AKA 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 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). +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. @@ -29,11 +29,11 @@ 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 +> 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 +**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 @@ -74,18 +74,20 @@ set undofile syntax on ``` +You should also run the `make format` command for repositories that contain custom formatting +rules in their Makefiles. After making the changes, commit them using the following format: ``` : ``` -Do not use long commit messages, instead add a description to your commit if needed. **Make sure the email you are +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 +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 +## Discussion +Join the [chat rooms](/wiki/chat) to discuss with the other developers, especially for larger changes and PRs.