Skip to content

Latest commit

 

History

History
99 lines (59 loc) · 3.33 KB

CONTRIBUTING.md

File metadata and controls

99 lines (59 loc) · 3.33 KB

How to contribute to this project

This project was build in gatsby.js v2, you can contribute by coding a feature, fixing a bug or writing an article.

If you want to contribute by coding or fixing a bug

First pick the issue that you would like to resolve from this list. Please don't resolve anything that its not an issue, if you would like to propose new enhancementes or report bugs you can create the issue first to discuss it with the project mantainers and other members of the community.

Once you have the issue that you like to solve, add a comment letting anyone know that you are going to be working on it.

Fork this project and clone it to have it on your local envirnoment.

This projects follows the all-contributors specification and your contribution will be recognized in the main README.md of the project.

If you would like to write an article

Here you will find all the articles inside the repository, some of them are:

  • Published: already finished but you can still make small changes like fixing grammar errors.
  • Draft: someone is already working on it but it's not finished yet.
  • Unassigned: no one has picked that article or started working on it.
  • Pending translation: there is already a version in another language and we need the translation for that particular language

Writing a new article

Pick of of the unasigned or pending_translation articles from this list and comment on the issue to start working on it.

Follow github markdown synax to write your article, we recomend using a text editor that supports markdown like stack edit.

We have also create some special icons and components that you can also use inside your article content:

Special Icons

[[info]] |:link: for links of webistes with information

[[warning]] | ☝️ to warn students about important details

[[demo]] | ☝️ For live demos

[[info]] | 📺 for external videos

[[info]] | ☝️ for Aditional info

Before and after

Example:

<before-after 
    before="https://ucarecdn.com/3681f907-21eb-4e0e-828e-f7e2690e8942/" after="https://ucarecdn.com/d6648701-2af4-4e2d-890c-17ed222bb66c/" />

Image

Syntax Highlighting

For inline syntax Highlighting

Start your inline code with the language followed by the > character, for example:

python>print("hello")

Will look like this: python>print("Hello")

Multiline syntax Highlighting

Start your code with three tildes like this: `

!(Syntax Highlighting Breathecode)[https://ucarecdn.com/8e196eb9-9aaa-41b1-a0f9-a62c1375ccfa/Screenshot20191121at73857PM.png]

Will look like this:

<strong>Hello</strong>
<p></p>

Adding Line Numbers

To add line numbers just add {numberLines: true} after your language declaration like this:

!(Adding line numbers to the code)[https://ucarecdn.com/20c9d797-9a40-4a0e-90a2-0ae0600f0fe0/Screenshot20191121at75439PM.png]


<p>This is some very big code</p>

<p>With lots of lines of code</p>