search

Samsung / tizen-docs

This project is for writing Tizen documents for platform and application developers. The documents will be published to the new Tizen portal site.
https://docs.tizen.org/
Other
151 stars 436 forks source link

readme

Tizen Docs

License License Build Status Build Status Repository Size

This repo contains Tizen documents for platform and application developers.

All files under ./docs/ are hosted on the Tizen Docs site.

NOTE

To contribute, see the Contributing Guide and the issues list.

Please take a look at the following instructions before starting.

Workflow

We are going to review Review/Requested PRs.

  1. Contributors have to attach Review/Requested, as soon as creating a PR.
  2. Reviewers have to change the label to Review/Reviewing when they starts to review a PR.
  3. When one of reviewers approve a PR, he/she has to update the label to Review/Scheduled.
  4. Although the state is Review/Scheduled others can change it to Review/Reviewing when more improvements are needed.

Naming rules

Naming Rules for Tizen Terms was added.

Headings style

Please see the Headings style.

...

Use sentence-style capitalization. Always capitalize:

  • The first word of a heading.
  • The word following a colon in a title or heading (for example, "How to: Sort an array").
    Headings should be done using atx-style, that is, use 1-6 hash characters (#) at the start of the line to indicate a heading, corresponding to HTML headings levels H1 through H6. Examples of first- and second-level headers are used above.

...

License

The Tizen documents in this project are licensed under the Creative Commons Attribution 3.0 License and the Code Examples are under the BSD-3-Clause License. See Content License for more details.