Skip to content

Define The README File Structure #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
romsi wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Define The README File Structure #1

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bb2c446
Add table of contents and titles in README file.
romsi May 17, 2018
6750cd0
Fix typos.
romsi May 18, 2018
06c568a
Update introduction for more context about the WHY
damienfraud May 18, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 48 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,48 @@
# medium-guidelines
Guidelines and good practices for Medium publications
# Medium Guidelines

This guidelines are made for people who love writing amazing stories on Medium. As developers, we often miss the opportunity to get benefits from sharing our experiences, knowledge and thinking.
Copy link
Copy Markdown

@damienfraud damienfraud May 18, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please, correct with These guidelines. I also believe we should develop this introduction a bit more to be more explicit about the goal of this document.

Copy link
Copy Markdown
Contributor Author

@romsi romsi May 18, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, please go ahead.


This document intend to be clear, consistent and brief.
Copy link
Copy Markdown

@damienfraud damienfraud May 18, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please, correct with This document intends. Also, I'm not sure this should appear in the README. If the document intends to be clear, brief and consistent, readers should be able to see it without us having to specify it. If this was specified for possible contributors, then maybe this is something we should add in a CONTRIBUTING file.

Copy link
Copy Markdown
Contributor Author

@romsi romsi May 18, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like it because it helps reader to quickly understand the philosophy behind it. You can access to a particular section without needed to read the others. Checkout Raywenderlich style guide.


## Table Of Contents

* [Content](#content)
* [Headlines](#headlines)
* [Images](#images)
* [Call to action](#call-to-action)
* [What I learned](#what-i-learned)
* [Cooperation](#cooperation)
* [Duration](#duration)
* [Frequency](#frequency)
* [Schedules](#schedules)
* [Social Media](#social-media)
* [Tags](#tags)
* [References](#references)

## Content

### Headlines

### Images

### Call to action

### What I Learned

## Cooperation

## Duration

## Assets

## Frequency

## Schedules

## Social Media

## Tags

## References

- [How to write Medium stories people will actually read - by Quincy Larson](https://medium.freecodecamp.org/how-to-write-medium-stories-people-will-actually-read-92e58a27c8d8)