Skip to content

Commit

Permalink
Add GitHub Docs (#20)
Browse files Browse the repository at this point in the history
* Add GitHub docs

* Fixes
  • Loading branch information
RehanSaeed authored and henrygab committed Oct 21, 2019
1 parent 58bccd9 commit 6f57185
Show file tree
Hide file tree
Showing 9 changed files with 171 additions and 0 deletions.
76 changes: 76 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
# 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, sex characteristics, 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 behaviour 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 behaviour 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
behaviour and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behaviour.

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 behaviours 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 behaviour may be
reported by contacting https://github.com/RehanSaeed. 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

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq
18 changes: 18 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# All contributions, however small are valued!

# Steps to contribute

If you want to make a small change, go ahead and raise a pull request, otherwise follow these steps:

1. View the [Issues](https://github.com/RehanSaeed/EditorConfig/issues) page to see a To-Do list of things to be implemented.
2. Raise an issue or comment on an existing issue with what you want to contribute if one does not already exist.
3. When you get the go ahead, follow the coding guidelines and raise a pull request.
4. Include a link to the issue in your pull request.

# Coding Guidelines

- Ensure that you write comments and that they are as short and simple as possible.

# Special Thanks

As thanks for all contributions, your username will be posted to the front page of the project with a short description of how you helped.
4 changes: 4 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
github: [RehanSaeed]
open_collective: editorconfig
patreon: rehansaeed
custom: ['https://paypal.me/MuhammadRehanSaeed']
28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/BUG_REPORT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
name: Bug Report
about: Create a report to help us improve
title: ''
labels: bug
assignees: ''
---

### Describe the bug

A clear and concise description of what the bug is.

### To Reproduce

A link to some code to reproduce the bug can speed up a fix. Alternatively, show steps to reproduce the behaviour:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

### Expected behaviour

A clear and concise description of what you expected to happen.

### Rules

Provide links to any [rules](https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference) in question.
15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATE/FEATURE_REQUEST.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
name: Feature Request
about: Suggest an idea for this project
title: ''
labels: enhancement
assignees: ''
---

### Describe the feature

A clear and concise description of what the feature is.

### Rules

Provide links to any [rules](https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference) in question.
15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATE/QUESTION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
name: Question
about: Ask a general question about how to use the project
title: ''
labels: question
assignees: ''
---

### Question

Ask your question.

### Rules

Provide links to any [rules](https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference) in question.
6 changes: 6 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<!--
Thank you good citizen for your hard work!
Please read the contributing guide before raising a pull request.
https://github.com/RehanSaeed/EditorConfig/blob/master/.github/CONTRIBUTING.md
-->
9 changes: 9 additions & 0 deletions .github/SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Security Policy

## Supported Versions

This project supports only the latest version with security updates. However, we'll do our best to help and answer questions about older versions.

## Reporting a Vulnerability

Contact [Muhammad Rehan Saeed](https://github.com/RehanSaeed) to report a security vulnerability. You will be thanked!
File renamed without changes.

0 comments on commit 6f57185

Please sign in to comment.