From 850252b9d06a7a2f978c6b6d89800bce7be37df6 Mon Sep 17 00:00:00 2001 From: Jacob Hrbek Date: Fri, 5 Jun 2020 07:18:43 +0000 Subject: [PATCH] Stubs in README --- .github/README.md | 58 +++++++++++++++++++++++++++++++++++------------ 1 file changed, 44 insertions(+), 14 deletions(-) diff --git a/.github/README.md b/.github/README.md index 8b97936..7445b4d 100644 --- a/.github/README.md +++ b/.github/README.md @@ -1,37 +1,67 @@ -FIXME: Source the header in different markdown file to make GitHub README different from GitLab. +**FIXME:** Markdownlint has to be optimized for this file
+**FIXME:** Source the header in different markdown file to make GitHub README different from GitLab. -FIXME: Change the name based on name repository used. +**FIXME:** Change the name based on name repository used.

Zernit (RXT0112)

-

System manager of WIP_NAME designed to work cross-platform and using multiple programming languages depending on which one provides the most efficiency per required runtime.

+

Community maintained (FIXME: Unknown clarification) designed to work cross-platform and using multiple programming languages depending on which one provides the most efficiency per required runtime on target system

- - - - - + + + + +

-NOTICE: Code-related implementation merge requests are currently not accepted due to the development of abstract and documentation assuming multi-language project. +**NOTICE:** Code-related implementation merge requests are currently not accepted due to the lack of repository management for multi-language project which is currently being worked on, however merge request will be processed if submitted with a priority affected by this restriction. -FIXME: Change the URL based on the website used
+**FIXME:** Change the URL based on the website used
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/RXT0112/RXT0112) -FIXME: Add pretty button
+**FIXME:** Add a pretty button
+**FIXME:** codesandbox currently cannot be used for zernit
+**FIXME:** Add tracking for scodsandbox usage on zernit
https://codesandbox.io/sgithub/RXT0112/RXT0112 -FIXME: Change the URL based on the website used
+**FIXME:** Change the URL based on the website used
+**FIXME:** repl.it currently cannot be used for zernit
+**FIXME:** Add tracking for scodsandbox usage on zernit
[![Run on Repl.it](https://repl.it/badge/github/RXT0112/Zernit)](https://repl.it/github/RXT0112/Zernit) -## What is considered a bug? -Everything relevant that does not work as expected or can be improved. The more issues we are awere of the more work we can put in to resolve them. +## When to make a new issue? + +### Questions +All relavant questions are welcomed and will be answered as soon as possible depending on the lenght of the question and the understanding of the supporter. + +### Bugs +Everything relevant that does not work as expected or can be improved. The more issues we are aware of the more work we can put in to resolve them. + +### Feature requests +Propose anything we will listen and consider it as long as it's relevant. + +## Mentoring program + +**NOTICE:** This is currently work in progress and provided with limited resources + +This project provides a free mentoring program for anyone who makes a new merge request with (TBD) + +This mentoring support is provided by the community for the community to provide a free education to improve the community-wide code quality and to ensure that everyone who wants to code has the resources to start and learn. + +If you need a help on projects outside of project RXT0112 then mension `@RXT0112/mentors` in your GitHub tickets. + +Mentoring support is also provided on community server (TBD) + +Project RXT0112 hopes to provide an environment for everyone to learn, freel free to mension our mentoring program in your repositories. + ## Where to get support + 1. For simple questions, guidance and mentoring use chat on https://webchat.freenode.net/#zernit-support 2. For complicated issues either: - Mension `@RXT0112/support` in your issues or relevant merge requests on GitHub - Make a new issue in relevant RXT0112 organization (anything relevant is welcomed!) +3. Sent an email on [zernit-support@rixotstudio.cz](mailto:zernit-support@rixotstudio.cz)