docs(contributing): rewrite (#248)

Co-authored-by: Almanov Nikita <[email protected]>

CONTRIBUTING.md

@@ -2,224 +2,32 @@
 
 First off, thanks for taking the time to contribute!
 
-All types of contributions are encouraged and valued.
-See the [**Table of Contents**](#table-of-contents) for different ways
-to help and details about how this project handles them.
-Please make sure to read the relevant section before making your contribution.
-It will make it a lot easier for us maintainers and smooth out the experience
-for all involved. The community looks forward to your contributions.
-
-> And if you like the project, but just don't have time to contribute,
-> that's fine. There are other easy ways to support the project
-> and show your appreciation, which we would also be very happy about:
->
-> - Star the project
-> - Tweet about it
-> - Refer this project in your project's readme
-> - Mention the project at local meetups and tell your friends/colleagues
-
-## Table of Contents
-
-- [Code of Conduct](#code-of-conduct)
-- [I Have a Question](#i-have-a-question)
-- [I Want To Contribute](#i-want-to-contribute)
-- [Reporting Bugs](#reporting-bugs)
-- [Suggesting Enhancements](#suggesting-enhancements)
-- [Improving The Documentation](#improving-the-documentation)
-
 ## Code of Conduct
 
 This project and everyone participating in it is governed by the
-[**Archoleat Repo Template Code of Conduct**](CODE_OF_CONDUCT.md).
+[**Code of Conduct**](CODE_OF_CONDUCT.md).
 By participating, you are expected to uphold this code.
 
-## I Have a Question
-
-> If you want to ask a question, we assume that you have read
-> the available [**Documentation**](README.md).
-
-Before you ask a question, it is best to search for existing
-[**Issues**](https://github.com/Archoleat/archoleat-repo-template/issues)
-that might help you. In case you have found a suitable **Issue** and still need
-clarification, you can write your question in this **Issue**.
-It is also advisable to search the internet for answers first.
-
-If you then still feel the need to ask a question and need clarification,
-we recommend the following:
-
-- Open an
- [**Issue**](https://github.com/Archoleat/archoleat-repo-template/issues/new/choose).
-
-- Provide as much context as you can about what you're running into.
-
-- Provide project and platform versions (**nodejs**, **npm**, etc),
- depending on what seems relevant.
-
-We will then take care of the **Issue** as soon as possible.
-
-## I Want To Contribute
-
-> ### Legal Notice
->
-> When contributing to this project, you must agree that you have authored 100%
-> of the content, that you have the necessary rights to the content and that
-> the content you contribute may be provided under the project license.
-
-### Reporting Bugs
-
-#### Before Submitting a Bug Report
-
-A good bug report shouldn't leave others needing to chase you up for more
-information. Therefore, we ask you to investigate carefully,
-collect information and describe the **Issue** in detail in your report.
-Please complete the following steps in advance to help us fix any
-potential bug as fast as possible.
-
-- Make sure that you are using the latest version.
-
-- Determine if your bug is really a bug and not an error on your side e.g.
- using incompatible environment components/versions
- (Make sure that you have read the [**Documentation**](README.md).
- If you are looking for support, you might want to check
- [**this section**](#i-have-a-question)).
-
-- To see if other users have experienced (and potentially already solved)
- the same **Issue** you are having, check if there is not already
- a bug report existing for your bug or error in the
- [**bug tracker**](https://github.com/Archoleat/archoleat-repo-template/issues?q=label%3Abug).
-
-- Also make sure to search the internet (including **Stack Overflow**)
- to see if users outside of the **GitHub community** have discussed
- the **Issue**.
-
-- Collect information about the bug:
-
- - Stack trace (Traceback).
-
- - OS, Platform and Version (**Windows**, **Linux**, **macOS**,
- **x86**, **ARM**).
-
- - Version of the **interpreter**, **compiler**, **SDK**,
- **runtime environment**, **package manager**, depending
- on what seems relevant.
-
- - Possibly your input and the output.
-
- - Can you reliably reproduce the **Issue**? And can you also reproduce
- it with older versions?
-
-#### How Do I Submit a Good Bug Report?
-
-> You must never report security related **Issues**, vulnerabilities or bugs
-> including sensitive information to the **Issue** tracker,
-> or elsewhere in public.
-
-We use GitHub **Issues** to track bugs and errors.
-If you run into an **Issue** with the project:
-
-- Open an
- [**Issue**](https://github.com/Archoleat/archoleat-repo-template/issues/new/choose).
- (Since we can't be sure at this point whether it is a bug or not,
- we ask you not to talk about a bug yet and not to label the **Issue**.)
-
-- Explain the behavior you would expect and the actual behavior.
-
-- Please provide as much context as possible and describe the
- *reproduction steps* that someone else can follow to recreate
- the **Issue** on their own. This usually includes your code.
- For good bug reports you should isolate the problem
- and create a reduced test case.
-
-- Provide the information you collected in the previous section.
-
-Once it's filed:
-
-- The project team will label the **Issue** accordingly.
-
-- A team member will try to reproduce the **Issue** with your provided steps.
- If there are no reproduction steps or no obvious way to reproduce
- the **Issue**, the team will ask you for those steps and mark the **Issue**
- as `needs-repro`. Bugs with the `needs-repro` tag will not be
- addressed until they are reproduced.
-
-- If the team is able to reproduce the **Issue**, it will be marked
- `needs-fix`, as well as possibly other tags (such as `critical`),
- and the **Issue** will be left to be
- [**implemented by someone**](#your-first-code-contribution).
-
-### Suggesting Enhancements
-
-This section guides you through submitting an enhancement suggestion for
-**Archoleat Repo Template**, **including completely new features and minor
-improvements to existing functionality**. Following these guidelines
-will help maintainers and the community to understand your suggestion
-and find related suggestions.
-
-#### Before Submitting an Enhancement
-
-- Make sure that you are using the latest version.
-
-- Read the [**Documentation**](README.md)
- carefully and find out if the functionality is already covered,
- maybe by an individual configuration.
-
-- Perform a
- [**search**](https://github.com/Archoleat/archoleat-repo-template/issues)
- to see if the enhancement has already been suggested.
- If it has, add a comment to the existing **Issue** instead
- of opening a new one.
-
-- Find out whether your idea fits with the scope and aims of the project
- It's up to you to make a strong case to convince the project's developer
- of the merits of this feature. Keep in mind that we want features that
- will be useful to the majority of our users and not just a small subset.
- If you're just targeting a minority of users, consider writing an
- add-on/plugin library.
-
-#### How Do I Submit a Good Enhancement Suggestion?
-
-Enhancement suggestions are tracked as [**GitHub Issues**](https://github.com/Archoleat/archoleat-repo-template/issues/new/choose).
-
-- Use a **clear and descriptive title** for the **Issue** to identify
- the suggestion.
-
-- Provide a **step-by-step description of the suggested enhancement**
- in as many details as possible.
-
-- **Explain why this enhancement would be useful** to most
- **Archoleat Repo Template** users. You may also want to point
- out the other projects that solved it better and which
- could serve as inspiration.
-
-### Improving The Documentation
+## Before Submitting Your Issue
 
-Enhancing the documentation of **Archoleat Repo Template** is
-crucial for ensuring it's usability and accessibility to a wider
-audience. Comprehensive and well-structured documentation empowers
-users to effectively leverage the template's features and effectively
-build their projects.
+Make sure there is no same or similar issue.
 
-#### Before Submitting Documentation Enhancements
+## The Title of Your Pull Request or Issue
 
-- Thoroughly review the existing
- documentation to identify areas for improvement. Consider aspects
- like clarity, comprehensiveness, and ease of navigation.
+Must conform to the conventional commits standard,
+example: `<type>[optional scope]: <description>`.
 
-- Clearly define the specific objectives
- of your proposed documentation enhancements. What specific aspects
- of the documentation need to be improved? How will these enhancements
- benefit users?
+## Reporting Bugs
 
-- Explain the context surrounding the proposed enhancements.
- Consider the current state of the documentation, any common user
- pain points, and how your suggestions address these issues.
+Go to **Issue > New Issue > Report a Bug**.
+Follow the instructions on the form.
 
-#### How to Submit Documentation Enhancements
+## Suggesting Features
 
-Enhancement suggestions are tracked as [**GitHub Issues**](https://github.com/Archoleat/archoleat-repo-template/issues/new/choose).
+Go to **Issue > New Issue > Request a Feature**.
+Follow the instructions on the form.
 
-- Use a **clear and descriptive title** for the **Issue** to identify
- the suggestion.
+## Improve Documentation
 
-- **Explain why this enhancement would be useful** to most
- **Archoleat Repo Template** users.
+Go to **Issue > New Issue > Report a Docs Issue**.
+Follow the instructions on the form.