Skip to content

Commit

Permalink
chore: Add repo documentation
Browse files Browse the repository at this point in the history
Add:
code of conduct file
issue templates
pull request template
contributing file
  • Loading branch information
JamesBurnside authored Feb 17, 2021
1 parent f3b5302 commit d4cc882
Show file tree
Hide file tree
Showing 5 changed files with 111 additions and 0 deletions.
9 changes: 9 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Microsoft Open Source Code of Conduct

This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).

Resources:

- [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/)
- [Microsoft Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
- Contact [[email protected]](mailto:[email protected]) with questions or concerns
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/report-a-bug.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name: Report a bug
about: Report a bug to help us improve.
title: "[what is the issue?] in [where is the issue?]"
labels: "status:triage"
assignees: ""
---

**Describe the bug; what happened?**

**What are the steps to reproduce the issue?**

**What behavior did you expect?**

**If applicable, provide screenshots:**

**In what environment did you see the issue?**

- OS & Device: [e.g. MacOS, iOS, Windows, Linux] on [iPhone 7, PC]
- Browser [e.g. Microsoft Edge, Google Chrome, Apple Safari, Mozilla FireFox]
- Version [e.g. 1.8.0]

**Is there any additional information?**
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/request-a-feature.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
name: Request a feature
about: Suggest a feature or share an idea.
title: Add [what] to/in [where]
labels: "status:triage"
assignees: ""
---

**What feature are you requesting?**

**What would be the benefit of adding this feature?**

**What solution would be ideal for you?**

**What alternatives have you considered?**

**Is there any additional information for your request?**

**Attach screenshots or images add detail to your request:**
59 changes: 59 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
<!--- Provide a summary of your changes in the title field above. For guidance on formatting, see the comment at the bottom of this template. -->

# Description

<!--- Describe your changes. -->

## Motivation & context

<!--- What problem does this change solve? -->
<!--- Provide a link if you are addressing an open issue. -->

## Issue type checklist

<!--- What type of change are you submitting? Put an x in the box that applies: -->

- [ ] **Chore**: A change that does not impact distributed packages.
- [ ] **Bug fix**: A change that fixes an issue, link to the issue above.
- [ ] **New feature**: A change that adds functionality.

**Is this a breaking change?**

- [ ] This change causes current functionality to break.

<!--- If yes, describe the impact. -->

## Process & policy checklist

<!--- Review the list and check the boxes that apply. -->

- [ ] I have added tests for my changes.
- [ ] I have tested my changes.
- [ ] I have updated the project documentation to reflect my changes if necessary.
- [ ] I have read the [CONTRIBUTING](https://github.com/Azure/communication-ui-sdk/blob/main/CONTRIBUTING.md) documentation.

<!---
Formatting guidelines:
Accepted peer review title format:
<type>: <description>
Example titles:
chore: add unit tests for all components
feat: add a border radius to button
fix: update design system to use 3px border radius
<type> is required to be one of the following:
- chore: A change that does not impact distributed packages.
- fix: A change which fixes an issue.
- feat: A that adds functionality.
<description> is required for the CHANGELOG and speaks to what the user gets from this PR:
- Be concise.
- Use all lowercase characters.
- Use imperative, present tense (e.g. `add` not `adds`.)
- Avoid redundant words.
-->
1 change: 1 addition & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Contributing

0 comments on commit d4cc882

Please sign in to comment.