scikit-learn / blog

Hosting the scikit-learn blog.
https://blog.scikit-learn.org
Creative Commons Attribution 4.0 International
15 stars 23 forks source link

Add Template Info to CONTRIBUTING.md #19

Open laurburke opened 2 years ago

laurburke commented 2 years ago

Formatting tips

Instructions on updating front matter

laurburke commented 2 years ago

@reshamas I'm not finished yet but could you take a look and let me know if the instructions make sense?

I'm also considering a new section that details the front matter more specifically.

reshamas commented 2 years ago

@laurburke The instructions are comprehensive and look great!

reshamas commented 2 years ago

To do: add example on adding image with attribution to CONTRIBUTING.md

Example:

<figure>
 <img src="/blog/assets/images/posts_images/Paris-s.jpg" alt="photo of Paris" max-width="50%" max-height="50%" /> 
 <figcaption>
 Photo credit: <a href="https://cmarmo.github.io">Chiara Marmo</a>
 </figcaption>
</figure>
laurburke commented 2 years ago

@reshamas I linked to instructions to Markdown but I agree that certain things, like adding images, should be specifically called out. Are there any other specific "code samples" you would like to have on the template guide?

reshamas commented 2 years ago

To add: highlighting text in blog

Read the full interview on Data Umbrella's blog:  
<span style="background-color: #CAE9F5;">  [Data Umbrella Interview: Juan Martín Loyola](https://blog.dataumbrella.org/jmloyola-opensource-experience) </span>
laurburke commented 2 years ago

Added! Anything else to add?