Skip to main content

🤝 Как написать?

Спасибо, что хотите поделится свомии идеями с сообществом! Этот проект открыт для всех, кто хочет поделиться полезными советами. Ниже — простые правила и инструкции.

✅ Что можно присылать​

  • Советы, хаки, best practices
  • Заметки по компонентам, настройкам, командам и т.п.
  • Всё, что может быть полезно другим

❌ Что не стоит присылать​

  • Спам и рекламные материалы
  • Повторы уже существующих советов. Если есть чем дополнить существующий совет то шлите мр с исправлением.
  • Неуважительный или токсичный контент

🛠 Шаги для внесения совета​

  1. Форкните репозиторий

  2. Создайте ветку:

    git checkout -b my-best-advise

  3. Добавьте Markdown-файл в нужный раздел community/, например: community/my-best-advise/my-best-advise.md

  4. Укажите в начале frontmatter:

    ---
    id: my-tip
    title: Мой полезный совет по стилистике
    description: Описание совета
    tags: [styleguide, Markdown, about]
    ---

  5. Напишите свой совет, используя Markdown (можно вставлять код, списки, ссылки, таблицы и т.д.)

  6. Создайте Pull Request с коротким описанием — что добавили и зачем.

💡 Стиль и формат​

  • Используйте заголовки ##, ### для структуры
  • Примеры кода — в блоках (js, bash и т.д.)

🔍 Модерация​

Этот раздел создан для комюнити, поэтому наполнение, проверка и апрув PR задача коммюнити.

  • Если ты видишь PR который достоин попасть сюда поставь ему лайк
  • Когда PR наберёт 50 лайков, он будет вмерджен в репозиторий и добавлен на сайт.