# How to Contribute

Want to make Mr. Doc better? Awesome! I _**deeply**_ thank you for checking out Mr. Doc. We need volunteers to help us make Mr. Doc the best documentation generator.

If this is your first time contributing to an open source project, check out some resources that will get you up and running:

* [Fork a Repo](https://help.github.com/articles/fork-a-repo/) by GitHub
* [Mastering Issues](https://guides.github.com/features/issues/) by GitHub
* [Mastering Markdown](https://guides.github.com/features/mastering-markdown/) by GitHub
* [Start Issues](http://hood.ie/blog/starter-issues.html) by [Gregor Martynus](https://github.com/gr2m)
* [TypeScript's Tutorial](http://www.typescriptlang.org/Tutorial)

**To contribute**, simply check out any of the issues and create a pull request after making changes in a forked repo.

**When creating an issue**, create the issue with enough descriptions so that it will be easier for us to find the root of the problem. A template will be provided for the issue so creating an issue isn't something that is intimidating.

## Coding Conventions

Try your best to follow the [Airbnb's Style Guide](https://github.com/airbnb/javascript) but since most of the code will be written in TypeScript, there will be a gulp task that will assist you in checking style issues for TypeScript.

## IDE

The IDE used frequently to develop Mr. Doc. are:

* Visual Studio Code
* Atom


## Contributor Code of Conduct

As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.

We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or nationality.

Examples of unacceptable behavior by participants include:

The use of sexualized language or imagery
Personal attacks
Trolling or insulting/derogatory comments
Public or private harassment
Publishing other's private information, such as physical or electronic addresses, without explicit permission
Other unethical or unprofessional conduct
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.

By adopting this Code of Conduct, project maintainers commit themselves to fairly and consistently applying these principles to every aspect of managing this project. Project maintainers who do not follow or enforce the Code of Conduct may be permanently removed from the project team.

This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community.

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting a project maintainer [@iwatakeshi](https://twitter.com/iwatakeshi) through Twitter's direct message. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. Maintainers are obligated to maintain confidentiality with regard to the reporter of an incident.

This Code of Conduct is adapted from the Contributor Covenant, version 1.3.0, available from http://contributor-covenant.org/version/1/3/0/