Skip to content
This repository has been archived by the owner on Dec 9, 2019. It is now read-only.

Latest commit

 

History

History
71 lines (52 loc) · 2.77 KB

CONTRIBUTING.md

File metadata and controls

71 lines (52 loc) · 2.77 KB

Contributing to Skygear Doc

♥ Skygear and want to get involved? Thanks! There are a lot of ways you can help!

For Skygear Server / SDK Development contribution, please refer to the contributing.md of skygear-server.

This document is specific for the contribution of skygear-doc

Please take a moment to read this document for the contribution process.

Skygear Doc Site Generator vs Content

There are two repo related with Skygear Doc:

  • SkygearIO/skygear-doc - Skygear Doc Site Generator, related with style, formating and generate the static doc guides
  • SkygearIO/guides - Skygear Guides in Markdown, all guides are in Markdown format and converted into HTML by Skygear Doc Site Generator

Using the issue tracker

The issue tracker of skygear-doc is for issues related with the site generator.

For issues related with the content of the Guide, please use issue tracker of guides. It is the preferred channel for change request, new guide idea and submitting pull requests.

Please do not use the issue tracker for:

  • Personal support requests
  • Feature / bug reports about Skygear

Instead use Stack Overflow , Skygear Google Group, or Skygear Slack Team.

The issue tracker have the following labels and their usage are:

  • Change - Change requests for existing Guide to avoid confusion, missing details, etc.
  • Guide - Issue tracking the writing or revamp of a complete guide.

Change Request

If you found that the existing guide need any changes due to outdated information, confusion, or area of improvements, please open a new issue with Change label.

Please try to search the Github Issue Tracker for existing issues. Please be as details as possible on the change you want.

It would also be great if a change issue can comes with a pull request :)

New Guide

Please open an issue labeled with Guide.

Each guide's content can have some overlap but for adding a new guide to Skygear Doc there should be a strong reason why the existing guide can't cover the topics already. It would be great if the issue can be specific about what the guide shall cover. A simple ToC could be included in an issue like that.

Pull requests

Please be advised that by submitting pull requests to this repo you've agreed to publish the change in MIT License.

// TODO: More to come