Skip to content

Commit

Permalink
Merge branch 'master' into master
Browse files Browse the repository at this point in the history
  • Loading branch information
Roshanjossey authored Oct 27, 2018
2 parents adcff8a + c53c629 commit ad01561
Show file tree
Hide file tree
Showing 200 changed files with 14,561 additions and 9,663 deletions.
53 changes: 53 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# Contribution guide

Welcome to your first contribution. :heart:

#### Before Contributing:
You need to run it locally on your desktop.

In order to do that:

Move to the desired location where package.json file is located

- Install npm(latest version) -
npm is distributed with Node.js - which means that when you download Node.js,
you automatically get npm installed on your computer.
https://www.npmjs.com/get-npm
- Install all the dependencies used by this project.
Use this command: `install npm`

- Run these final commands to run it locally:

`npm run build`

`npm start`

#### Table Of Contents
- [Code of Conduct](#code-of-conduct)
- [Translation Guide](#translation-guide)

## Code of Conduct
If you want to contribute, you need to know a few things.

[Code of conduct](../CODE_OF_CONDUCT.md)

## Translation Guide
We have some rules for translation. If you make the first translation for your language, you must add your language list on `Translations.md`.

#### Example

`Translations.md`
```markdown
|Country | Translated Link |
| --- | --- |
| English | [English](../README.md) |
| 🇮🇳 India | [Hindi](../translations/README.hi.md) |
| 🇲🇲 Myanmar | [Myanmar Unicode](../translations/README.mm_unicode.md), Myanmar ZawGyi |
```

## TODO
- [ ] Fix the grammar for the contribution guide.
- [ ] Add more examples and more guides.


Thanks! :heart:
10 changes: 5 additions & 5 deletions ISSUE_TEMPLATE.md → .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@

📋 **Steps to solve the problem**

* Comment below about what you've started working on.
* Add, commit, push your changes
* Submit a pull request and add this in comments - `Addresses #<put issue number here>`
* Ask for a review in comments section of pull request
* Celebrate your contribution to this project 🎉
* Comment below about what you've started working on.
* Add, commit, push your changes.
* Submit a pull request and add this in comments - `Addresses #<put issue number here>`
* Ask for a review in comments section of pull request.
* Celebrate your contribution to this project. 🎉
32 changes: 31 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,20 @@
#
.DS_Store

#eslint
#
.eslintcache

# Logs
#
logs
*.log
npm-debug.log*

# temp files
#
*.~temp

# Xcode
#
build/
Expand Down Expand Up @@ -40,7 +54,6 @@ local.properties
# node.js
#
node_modules/
npm-debug.log

# coverage
#
Expand All @@ -51,3 +64,20 @@ coverage/
#
config.json
/.vs

#Visual Studio Code
#
.vscode/*

#Sublime Text
#
*.sublime-project
*.sublime-workspace

#Vim
#
*.swp
*.swo
Session.vim
.netrwhist
*~
25 changes: 11 additions & 14 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,22 +14,19 @@ orientation.
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
* 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
* 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

Expand All @@ -55,7 +52,7 @@ further defined and clarified by project maintainers.
## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting [[email protected]](mailto:[email protected]).
reported by contacting [[email protected]](mailto:[email protected]).
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
Expand Down
33 changes: 0 additions & 33 deletions CONTRIBUTING.md

This file was deleted.

Loading

0 comments on commit ad01561

Please sign in to comment.