-
Notifications
You must be signed in to change notification settings - Fork 326
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Docs: update README.md and add github related docs
- Loading branch information
Showing
9 changed files
with
643 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# http://editorconfig.org | ||
|
||
# top-most EditorConfig file | ||
root = true | ||
|
||
# Unix-style newlines with a newline ending every file | ||
[*] | ||
charset = utf-8 | ||
end_of_line = lf | ||
insert_final_newline = true | ||
trim_trailing_whitespace = true | ||
|
||
# Indentation override for c# files | ||
[*.cs] | ||
indent_size = 4 | ||
indent_style = space | ||
|
||
# Trailing space override for markdown file | ||
[*.md] | ||
trim_trailing_whitespace = false | ||
|
||
# Indentation override for config files | ||
[*.{json,yml}] | ||
indent_size = 2 | ||
indent_style = space |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,200 @@ | ||
# Details per file setting: | ||
# text These files should be normalized (i.e. convert CRLF to LF). | ||
# binary These files are binary and should be left untouched. | ||
|
||
# Auto detect text files and perform LF normalization | ||
* text=auto | ||
# The above will handle all files NOT found below | ||
|
||
# SOURCE CODE | ||
*.bat text eol=crlf | ||
*.c text | ||
*.cc text | ||
*.coffee text | ||
*.cpp text | ||
*.css text | ||
*.go text | ||
*.h text | ||
*.hh text | ||
*.hpp text | ||
*.html text | ||
*.inc text | ||
*.ini text | ||
*.java text | ||
*.js text | ||
*.jsx text | ||
*.less text | ||
*.php text | ||
*.proto text | ||
*.py text | ||
*.rb text | ||
*.sass text | ||
*.sass text | ||
*.scss text | ||
*.sh text eol=lf | ||
*.sql text | ||
*.styl text | ||
*.ts text | ||
*.tsx text | ||
*.vue text | ||
*.xml text | ||
*.xhtml text | ||
|
||
# DOCKER | ||
*.dockerignore text | ||
Dockerfile text | ||
|
||
# DOCUMENTATION | ||
*.markdown text | ||
*.md text | ||
*.mdwn text | ||
*.mdown text | ||
*.mkd text | ||
*.mkdn text | ||
*.mdtxt text | ||
*.mdtext text | ||
*.txt text | ||
AUTHORS text | ||
CHANGELOG text | ||
CHANGES text | ||
CONTRIBUTING text | ||
COPYING text | ||
copyright text | ||
*COPYRIGHT* text | ||
INSTALL text | ||
license text | ||
LICENSE text | ||
NEWS text | ||
readme text | ||
*README* text | ||
TODO text | ||
|
||
# TEMPLATES | ||
*.ejs text | ||
*.haml text | ||
*.jade text | ||
*.tmpl text | ||
*.twig text | ||
|
||
# CONFIGS | ||
*.babelrc text | ||
*.bowerrc text | ||
*.cnf text | ||
*.conf text | ||
*.config text | ||
.editorconfig text | ||
.gitattributes text | ||
.gitconfig text | ||
.gitignore text | ||
.htaccess text | ||
*.json text | ||
*.lock text | ||
Procfile text | ||
*.yaml text | ||
*.yml text | ||
Makefile text | ||
makefile text | ||
|
||
# LINTERS | ||
.csslintrc text | ||
.eslintrc text | ||
.eslintignore text | ||
.htmlhintrc text | ||
.jscsrc text | ||
.jshintrc text | ||
.jshintignore text | ||
.stylelintrc text | ||
.stylelignore text | ||
|
||
# GRAPHICS | ||
*.ai binary | ||
*.bmp binary | ||
*.eps binary | ||
*.gif binary | ||
*.ico binary | ||
*.jng binary | ||
*.jp2 binary | ||
*.jpg binary | ||
*.jpeg binary | ||
*.jpx binary | ||
*.jxr binary | ||
*.pdf binary | ||
*.png binary | ||
*.psb binary | ||
*.psd binary | ||
*.svg text | ||
*.svgz binary | ||
*.tif binary | ||
*.tiff binary | ||
*.wbmp binary | ||
*.webp binary | ||
|
||
# AUDIO | ||
*.kar binary | ||
*.m4a binary | ||
*.mid binary | ||
*.midi binary | ||
*.mp3 binary | ||
*.ogg binary | ||
*.ra binary | ||
|
||
# VIDEO | ||
*.3gpp binary | ||
*.3gp binary | ||
*.as binary | ||
*.asf binary | ||
*.asx binary | ||
*.fla binary | ||
*.flv binary | ||
*.m4v binary | ||
*.mng binary | ||
*.mov binary | ||
*.mp4 binary | ||
*.mpeg binary | ||
*.mpg binary | ||
*.ogv binary | ||
*.swc binary | ||
*.swf binary | ||
*.webm binary | ||
|
||
# ARCHIVES | ||
*.7z binary | ||
*.gz binary | ||
*.jar binary | ||
*.rar binary | ||
*.tar binary | ||
*.zip binary | ||
|
||
# FONTS | ||
*.ttf binary | ||
*.eot binary | ||
*.otf binary | ||
*.woff binary | ||
*.woff2 binary | ||
|
||
# Compiled Object files | ||
*.slo binary | ||
*.lo binary | ||
*.o binary | ||
*.obj binary | ||
|
||
# Precompiled Headers | ||
*.gch binary | ||
*.pch binary | ||
|
||
# Compiled Dynamic libraries | ||
*.so binary | ||
*.dylib binary | ||
*.dll binary | ||
|
||
# Compiled Static libraries | ||
*.lai binary | ||
*.la binary | ||
*.a binary | ||
*.lib binary | ||
|
||
# EXECUTABLES | ||
*.exe binary | ||
*.pyc binary | ||
*.out binary | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,73 @@ | ||
# Contributor Covenant Code of Conduct | ||
|
||
## Our Pledge | ||
|
||
In the interest of fostering an open and welcoming environment, we as | ||
contributors and maintainers pledge to making participation in our project and | ||
our community a harassment-free experience for everyone, regardless of age, body | ||
size, disability, ethnicity, gender identity and expression, level of experience, | ||
education, socio-economic status, nationality, personal appearance, race, | ||
religion, or sexual identity and orientation. | ||
|
||
## Our Standards | ||
|
||
Examples of behavior that contributes to creating a positive environment | ||
include: | ||
|
||
* Using welcoming and inclusive language | ||
* Being respectful of differing viewpoints and experiences | ||
* Gracefully accepting constructive criticism | ||
* Focusing on what is best for the community | ||
* Showing empathy towards other community members | ||
|
||
Examples of unacceptable behavior by participants include: | ||
|
||
* The use of sexualized language or imagery and unwelcome sexual attention or | ||
advances | ||
* Trolling, insulting/derogatory comments, and personal or political attacks | ||
* Public or private harassment | ||
* Publishing others' private information, such as a physical or electronic | ||
address, without explicit permission | ||
* Other conduct which could reasonably be considered inappropriate in a | ||
professional setting | ||
|
||
## Our Responsibilities | ||
|
||
Project maintainers are responsible for clarifying the standards of acceptable | ||
behavior and are expected to take appropriate and fair corrective action in | ||
response to any instances of unacceptable behavior. | ||
|
||
Project maintainers have the right and responsibility to remove, edit, or | ||
reject comments, commits, code, wiki edits, issues, and other contributions | ||
that are not aligned to this Code of Conduct, or to ban temporarily or | ||
permanently any contributor for other behaviors that they deem inappropriate, | ||
threatening, offensive, or harmful. | ||
|
||
## Scope | ||
|
||
This Code of Conduct applies both within project spaces and in public spaces | ||
when an individual is representing the project or its community. Examples of | ||
representing a project or community include using an official project e-mail | ||
address, posting via an official social media account, or acting as an appointed | ||
representative at an online or offline event. Representation of a project may be | ||
further defined and clarified by project maintainers. | ||
|
||
## Enforcement | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
reported by contacting the project team at [INSERT EMAIL ADDRESS]. All | ||
complaints will be reviewed and investigated and will result in a response that | ||
is deemed necessary and appropriate to the circumstances. The project team is | ||
obligated to maintain confidentiality with regard to the reporter of an incident. | ||
Further details of specific enforcement policies may be posted separately. | ||
|
||
Project maintainers who do not follow or enforce the Code of Conduct in good | ||
faith may face temporary or permanent repercussions as determined by other | ||
members of the project's leadership. | ||
|
||
## Attribution | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, | ||
available at [https://www.contributor-covenant.org/version/1/4/code-of-conduct.html](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html) | ||
|
||
[homepage]: https://www.contributor-covenant.org |
Oops, something went wrong.