# Contributing

Introduction
There are 2 ways of contributing: Simple and Advanced
- Edit Directly on GitLab (Simple)
  - Using "Help us improve here" Link
  - Edit with Gitlab Web IDE
- Downloading our repo (Advanced)
  - Requirements
  - Run
Making an MR (Merge Request)
How to suggest a feature or enhancement.
Code review process

Please take a moment to review this document to make the contribution process easy and effective for everyone involved.

# Introduction

You are here because you want to give your PLUS and improve our documentation? Awesome!, feel welcome and read the following sections to know how to ask questions and how to work on something.

All members of our team are expected to follow our Code of Conduct. Please make sure you are welcoming and friendly in all our spaces.

There are many ways to contribute, like writing tutorials, improving documentation, sending feature requests, or writing code that can solve a common problem.

Keep in mind:

We have a style for code
We use commit message conventions
Gif files should have less than 2mb of size for the service worker to cache them
You should use Tags to reference highlight words that are not h1, h2, or h3 headings. These highlight words can be h4, h5, or keywords that you may want to make available on the search results.
- You can place tags in the tags section of the .md header. For example:
- ```
---
date: 2020-3-10 3:30:18 

collaborators:
  - Roy Calderon
  - Neiro Méndez
meta:
  - name: description
    content: Docs PLUSTEAM
tags:
  - Tag 1
  - Tag 2
  - Tag N
---
```
  1
  2
  3
  4
  5
  6
  7
  8
  9
  10
  11
  12
  13
  14
- Add as many tags as you may find necessary
- When searching, and there is a match, you will notice it because it only appears the main title of the page that matches. In this example, the page Contributing appears in the result page because it contains a tag called Tags
- h1, h2, and h3 titles have precedence over words declared in the tags section, so don't use tags for the same words that have already appeared in any h1, h2, or h3 titles of the same .md file, as they won't appear in the search results.

# There are 2 ways of contributing: Simple and Advanced

# Edit Directly on GitLab (Simple)

# Using "Help us improve here" Link

You will find a Help us improve here! link at the end of each page. This link will allow you to edit the said file directly on GitLab.

Make your changes and then fill the commit message. Once you're done, click on the "Commit changes" button. Remember We use commit message conventions, so be sure to follow all the conventions found there.

Once you make your changes make a merge request

Add Assignee, Labels and the related Milestone if available, and then select Merge Options Delete source branch when merge request is accepted.

Lastly, click on Submit merge request button to finish the edition.

If you'd like to learn more about "Edit Directly on Gitlab" go here to get more information.

# Edit with Gitlab Web IDE

# Create a New branch

First, create a new branch

Now You will see all the files of the project

Make your changes and then click on Commit button. If you finish editing, click the option Start a new merge request

Change branches to the branch you used to create the branch feature/edit_contributing in this case develop

Once you change the branch add Assignee, add Assignee, Labels, and the related Milestone if available.

Lastly, click on Submit merge request button to finish the edition.

# Downloading our repo (Advanced)

Just get the project from cloning the repository, make sure you have the requirements, and run it.

# Requirements

NodeJS
VuePress

# install globally
yarn global add vuepress
# OR
npm install -g vuepress

1
2
3
4

# Run

Go to the project folder and

# run npm install
then 
# run project in development mode
vuepress dev or npm run dev

1
2
3
4

At this point, you're ready to make your changes!

Feel free to ask for help, everyone is a beginner at first.

# Making an MR (Merge Request)

All changes start on Develop Branch, we have a brief guide to help you with that.

# How to suggest a feature or enhancement.

We use Asana fro this. You can ask for access to our founders and enter into the workspace to leave your suggestions in "+Docs - Backlog"

# Code review process

We have QA Guidelines where we mention all the Code review process

← Changelog