fix (*): Created project

kawaii-lang · Oct 1, 2016 · 2ca2552 · 2ca2552
commit 2ca2552
Show file tree

Hide file tree

Showing 4 changed files with 237 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,183 @@
+# Contributing
+
+ *  [Support](#support)
+ *  [Committing](#committing)
+ *  [Issues](#issues)
+ *  [Pull requests](#pull-requests)
+ *  [Coding rules](#coding-rules)
+ *  [Branching](#branching)
+
+## Support
+
+Feel free to ask us anything you want at our
+[official channels][channels],
+but don't forget our [rules][]
+
+
+
+## Committing
+
+ *  Commit must be as atomic as possible.
+ *  Commit messages must be as terse as possible,
+    but without big damage to information value.
+ *  Commit message format (similar with Angular's one):
+
+    ````
+    <type> (<scope>): <subject>
+    <blank line>
+    <body>
+    <blank line>
+    <footer>
+    ````
+ *  Types:
+    *  `fix` — issue fix
+       (presented at `release-x.y.z` branches).
+    *  `documentation` — documentation update.
+    *  `revert` — this commit reverts other commit.
+    *  `feature` — new feature
+       (first commit in `feature-*` branch).
+    *  `style` — code style change.
+    *  `performance` — performance improvement.
+    *  `refactoring` — refactoring.
+    *  `tests` — adding missing tests.
+    *  `chore` — changes in build system etc.
+ *  Scopes:
+    *  Scopes are repository-specific.
+       See `CONTRIBUTING.md` files in each repository.
+ *  Subject:
+    *  Describe change in few words.
+    *  Use past tense.
+    *  If possible, capitalize first letter.
+    *  Don't add the dot at the end of line.
+ *  Body:
+    *  Describe change and it's reason.
+    *  Provide previous behaviour description.
+    *  Use past tense.
+    *  If possible, capitalize first letter
+       of each sentence.
+    *  Add dot etc. at the end of each sentence.
+    *  Use Markdown.
+ *  Footer:
+    *  Only presented in breaking commits.
+    *  Starts with `BREAKING CHANGE:` keyword
+       and whitespace or two newlines.
+    *  Footer must include description
+       of breaking change and migration notes.
+
+
+
+## Issues
+
+ *  Before opening an issue:
+     *  Find for already existing similar ones.
+     *  Open a new one, only if there are no issues,
+        describing your problem.
+ *  Issue format:
+    
+    ````
+    <subject>
+    
+    ## TL;DR
+    <overview>
+    
+    ## Motivation
+    <motivation>
+    
+    ## Version
+    <affected version or commit>
+    
+    ## Environment
+    <OS and other related software versions>
+    
+    ## Reproduction
+    <how to reproduce>
+    
+    ## Stack
+    <stack trace, logs and other related data>
+    
+    ## Suggestion
+    <how would you fix it>
+    
+    ## Related
+    <related issues>
+    ````
+ *  Subject:
+     *  Use imperative mood.
+     *  If possible, use polite speak.
+     *  Describe desired change in a few words.
+ *  Overview:
+     *  Describe desired change using free form.
+     *  Use more verbose style, than in the subject.
+ *  Motivation:
+     *  Describe, why it is a problem.
+ *  Affected version or commit:
+     *  If the issue presented in tagged version,
+        refer to the corresponding tag.
+     *  If the issue presented in development version,
+        refer to the commit representing your version.
+ *  OS and other related software versions:
+     *  OS version.
+     *  Lexer implementation language
+        and runtime (e. g. TS 2, Node 6).
+ *  How to reproduce:
+     *  Steps to reproduce error.
+ *  Stack trace, logs and other related data:
+     *  Optional.
+     *  Includes stack traces, logs, configs
+        and other data, which may be useful for developers.
+ *  Suggestion:
+     *  Suggest us, how to fix the issue.
+     *  Optional, if you have no idea how to do this.
+ *  Related:
+     *  Specify related issues.
+     *  Describe, why you open new issue,
+        when there are similar ones already.
+     *  Optional, if you can't find similar issues.
+
+
+
+## Pull requests
+
+ *  Before opening new pull request:
+     *  Find for already existing similar ones.
+     *  Open a new one, only if there are no pull requests,
+        duplicating your one.
+ *  Follow branching rules.
+ *  Follow coding rules.
+ *  Pull request must include tests, covering all changes.
+ *  All tests must pass.
+
+
+
+## Coding rules
+
+ *  All public API must be documented
+    using JSDoc, JavaDoc, etc.
+ *  See existing sources to figure out,
+    what we mean when talking about coding style.
+
+
+
+## Branching
+
+Repositories of Kawaii projects
+includes following branches:
+
+ *  `master` — production-ready code only, latest version.
+ *  `latest` — development version.
+     *  Branches off from `master`.
+     *  Merges into `master`.
+ *  `release-x.y.0` — one branch per release.
+     *  Branches off from `dev`.
+     *  Merges into `dev` and `master`.
+ *  `release-x.y.z` — one branch per fix.
+     *  Branches off from `release-x.y.0`.
+     *  Merges into `release-x.y.0`, `master` and `latest`.
+ *  `feature-*` — one branch per feature.
+     *  Branches off from `latest`.
+     *  Merges into `latest`.
+
+
+
+[channels]: https://kawaii-lang.github.io/channels
+[rules]:    https://kawaii-lang.github.io/rules
diff --git a/LICENSE.md b/LICENSE.md
@@ -0,0 +1,26 @@
+Copyright © 2016 Alice Klipper and contributors
+
+Permission is hereby granted, free of charge,
+to any person obtaining a copy of this software
+and associated documentation files (the "Software"),
+to deal in the Software without restriction,
+including without limitation the rights
+to use, copy, modify, merge, publish, distribute,
+sublicense, and/or sell copies of the Software,
+and to permit persons to whom the Software
+is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice
+shall be included in all copies
+or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS",
+WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS
+OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF
+OR IN CONNECTION WITH THE SOFTWARE
+OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,6 @@
+# KAWAII CAPS
+
+THIS REPOSITORY INCLUDES COMMON INFORMATION
+ON KAWAII PROJECTS.
+
+CAPS LOCK ISN'T A BUG, IT'S A FEATURE.
diff --git a/RULES.md b/RULES.md
@@ -0,0 +1,22 @@
+# Rules
+
+ 1. We respect everyone who contributed
+    to Kawaii projects by any possible way.
+ 2. Communications at any official channels
+    must be constructive.
+ 3. You must avoid of trolling, insult, harassment,
+    provocations and other attacks.
+ 4. You must be tolerant, at least,
+    when you are contributing to Kawaii projects
+    or communicating through our official channels.
+ 5. Every contributor have a liberty
+    to have own opinion at different questions,
+    which are not directly related to Kawaii.
+    These opinions must not affect development of Kawaii.
+    These opinions must not present at channels,
+    directly related to Kawaii.
+
+___________________________________________________________
+
+ *  List of official channels see at our official site:
+    <https://kawaii-lang.github.io/channels>