Skip to content

Update README.md #2101

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

Closed
wants to merge 1 commit into from
Closed

Update README.md #2101

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
61 changes: 1 addition & 60 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,60 +1 @@
# Tizen Docs

[![License](https://licensebuttons.net/l/by/3.0/88x31.png)](content-license.md)
[![License](https://img.shields.io/badge/licence-BSD-green.svg?style=flat)](LICENSE-CODE)
[![Build Status](https://jenkins-docs.stg.tizen.org/buildStatus/icon?job=STG_docs_PR_builder&subject=master%20build)](https://jenkins-docs.stg.tizen.org/job/STG_docs_PR_builder/)
[![Build Status](https://jenkins-docs.stg.tizen.org/buildStatus/icon?job=PRD_docs&subject=live%20build)](https://jenkins-docs.stg.tizen.org/job/PRD_docs/)
![Repository Size](https://img.shields.io/github/repo-size/Samsung/tizen-docs)

This repo contains Tizen documents for platform and application developers.

All files under ./docs/ are hosted on the [Tizen Docs site](https://docs.tizen.org).


## NOTE

To contribute, see the [Contributing Guide](CONTRIBUTING.md) and the [issues list](https://github.com/Samsung/tizen-docs/issues).

Please take a look at the following instructions before starting.

### Workflow

We are going to review <span class="labels lh-default d-block d-md-inline">
<a class="d-inline-block IssueLabel" style="background-color: #6ee5bb; color: #000000" title="Push a new commit. It seems like a patch set." href="https://github.com/Samsung/tizen-docs/pulls?q=is%3Apr+is%3Aopen+label%3AReview%2FRequested">Review/Requested</a> PRs.
</span>
1. Contributors have to attach <span class="labels lh-default d-block d-md-inline">
<a class="d-inline-block IssueLabel" style="background-color: #6ee5bb; color: #000000" title="Push a new commit. It seems like a patch set." href="https://github.com/Samsung/tizen-docs/pulls?q=is%3Apr+is%3Aopen+label%3AReview%2FRequested">Review/Requested</a>, as soon as creating a PR.
</span>
2. Reviewers have to change the label to <span class="labels lh-default d-block d-md-inline">
<a class="d-inline-block IssueLabel" style="background-color: #229fa5; color: #000000" title="Asking review for publishing" href="https://github.com/Samsung/tizen-docs/pulls?q=is%3Apr+is%3Aclosed+label%3AReview%2FReviewing">Review/Reviewing</a> when they starts to review a PR.
</span>
3. When one of reviewers approve a PR, he/she has to update the label to <span class="labels lh-default d-block d-md-inline">
<a class="d-inline-block IssueLabel" style="background-color: #0523aa; color: #ffffff" title="Ready for publishing" href="https://github.com/Samsung/tizen-docs/pulls?q=is%3Apr+is%3Aopen+label%3AReview%2FScheduled">Review/Scheduled</a>.
</span>
4. Although the state is <span class="labels lh-default d-block d-md-inline">
<a class="d-inline-block IssueLabel" style="background-color: #0523aa; color: #ffffff" title="Ready for publishing" href="https://github.com/Samsung/tizen-docs/pulls?q=is%3Apr+is%3Aopen+label%3AReview%2FScheduled">Review/Scheduled</a>
</span> others can change it to <a class="d-inline-block IssueLabel" style="background-color: #229fa5; color: #000000" title="Asking review for publishing" href="https://github.com/Samsung/tizen-docs/pulls?q=is%3Apr+is%3Aclosed+label%3AReview%2FReviewing">Review/Reviewing</a> when more improvements are needed.

### Naming rules

[**Naming Rules for Tizen Terms**](./styleguide/naming-rules.md) was added.


### Headings style

Please see the [**Headings style**](./styleguide/style.md#headings).

> ...
>
> 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](https://creativecommons.org/licenses/by/3.0/) License and the Code Examples are under the [BSD-3-Clause License](https://www.tizen.org/bsd-3-clause-license). See [Content License](content-license.md) for more details.
tição Baby