fix: update issue templates

AlaskaAirlines · Dec 14, 2019 · 7f57397 · 7f57397
1 parent e526cca
commit 7f57397
Show file tree

Hide file tree

Showing 17 changed files with 247 additions and 76 deletions.
diff --git a/.github/.DS_Store b/.github/.DS_Store
diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md
@@ -1,4 +1,4 @@
-# Orion Design System Code of Conduct
+# Code of Conduct
 
 ## Our Pledge
 

diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -1,4 +1,4 @@
-# Orion Design System Contributing Guidelines
+# Contributing Guidelines
 
 Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.
 

diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: 'Type: Bug'
+assignees: blackfalcon
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1 @@
+blank_issues_enabled: false
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: 'Type: Feature'
+assignees: blackfalcon
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.
diff --git a/.github/ISSUE_TEMPLATE/general-support.md b/.github/ISSUE_TEMPLATE/general-support.md
@@ -0,0 +1,30 @@
+---
+name: General support
+about: Suggestions that are not related to bugs or new features
+title: ''
+labels: 'Type: Question'
+assignees: blackfalcon
+
+---
+
+# General Support Request
+<!---  The scope of this request is to neither communicate a bug or feature request.  -->
+<!---  If this is a bug or feature request, please close this issue and reference the previus templates.  -->
+
+## Support request
+<!--- Please describe the issue you are reporting -->
+
+## Possible Solution
+<!--- Not obligatory, but suggest a fix/reason for the bug, -->
+<!--- or ideas how to implement the addition or change -->
+
+## Context
+<!--- How has this issue affected you? What are you trying to accomplish? -->
+<!--- Providing context helps us come up with a solution that is most useful in the real world -->
+
+## Your Environment
+<!--- Include as many relevant details about the environment you experienced the bug in -->
+* Version used:
+* Browser Name and version:
+* Operating System and version (desktop or mobile):
+* Link to your project:
diff --git a/template/.DS_Store b/template/.DS_Store
diff --git a/template/.github/.DS_Store b/template/.github/.DS_Store
diff --git a/template/.github/CODE_OF_CONDUCT.md b/template/.github/CODE_OF_CONDUCT.md
@@ -1,4 +1,4 @@
-# Orion Design Tokens Code of Conduct
+# Code of Conduct
 
 ## Our Pledge
 

diff --git a/template/.github/CONTRIBUTING.md b/template/.github/CONTRIBUTING.md
@@ -1,4 +1,4 @@
-# Orion Design Tokens Contributing Guidelines
+# Contributing Guidelines
 
 Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.
 
@@ -22,14 +22,61 @@ Poor bug reports will be reassigned back to the creator for revision prior to an
 
 ## Submitting pull requests
 
-No one other than repository managers have direct access to the repository. For all pull requests you must first fork the project to your own Github account. 
+No one other than repository managers have direct access to the repository. For all pull requests you must first fork the project to your own Github account.
 
 All new work that is to be considered for merging with the `MASTER` branch must start from a new feature branch of work. This feature branch should be in response to either a bug or a new business requirement.
 
-#### Feature branch naming
+### Feature branch naming
 
 The name of the feature branch should be descriptive as to the nature of the work and please include any references to the story or bug work item ID.
 
+### Conventional Commits
+
+This project utilizes [Conventional Commits](https://www.conventionalcommits.org/) to auto-generate release verions, based on the [Angular Commit Message Guidelines](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#-commit-message-guidelines).
+
+
+```
+<type>[optional scope]: <description>
+```
+
+All commit messages must be prefixed with a specific type so that the semver release configuration can analyze the commit and apply the correct version release. Please see the following types with their respective meanings.
+
+#### MAJOR
+
+For a MAJOR release, you MUST follow this template. The use of `perf:` and `BREAKING CHANGE:` are needed in order to push a major release.
+
+```
+perf(pencil): remove graphiteWidth option
+
+BREAKING CHANGE: The graphiteWidth option has been removed.
+The default graphite width of 10mm is always used for performance reasons.
+```
+
+#### MINOR
+```
+feat(pencil): add 'graphiteWidth' option
+```
+
+#### PATCH
+```
+fix(pencil): stop graphite breaking when too much pressure applied
+```
+
+#### Other commit types
+
+| type | description |
+|---|---|
+| build | Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm) |
+| ci | Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs) |
+| docs | Documentation only changes |
+| feat | A new feature (this correlates with `MINOR` in semantic versioning) |
+| fix | A bug fix (this correlates with `PATCH` in semantic versioning) |
+| perf | A code change that improves performance (correlating with `MAJOR` in semantic versioning) |
+| BREAKING CHANGE | A code change that is not backwards compatable (correlating with `MAJOR` in semantic versioning) |
+| refactor | A code change that neither fixes a bug nor adds a feature |
+| style | Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) |
+| test | Adding missing tests or correcting existing tests  |
+
 #### Git commit messages
 
 Once you have completed your feature update, please commit all changes to the branch. All commit messages should use an **imperative mood**.
@@ -49,11 +96,25 @@ For example:
 * If applied, this commit will `refactor component X for accessibility`
 * If applied, this commit will `add feature Y to component X`
 
-#### Push branch and submit pull request
+Example messages when using Conventional Commits:
+
+```
+$ build: update to Gulp 4.x
+
+$ docs: address issue #14, typo in install instructions
+
+$ perf: restructure API to comply with new feature spec
+
+$ feat: add ability to consume large data as an array versus string
+
+$ fix: address issue #57 in regards to color output
+```
+
+### Push branch and submit pull request
 
 One you have committed new work to your feature branch, be sure to push your updates to the Github repository. Depending on your IDE or CLI configuration this may be a manual or automatic step.
 
-To submit a new pull request, please go to [https://github.com/AlaskaAirlines](https://github.com/AlaskaAirlines) to find your project and submit the Pull Request. 
+To submit a new pull request, please go to [https://github.com/AlaskaAirlines](https://github.com/AlaskaAirlines) to find your project and submit the Pull Request.
 
 On the pull request page, the new pull request should be `[your-new-branch] into [master]`
 

diff --git a/template/.github/ISSUE_TEMPLATE.md b/template/.github/ISSUE_TEMPLATE.md
diff --git a/template/.github/ISSUE_TEMPLATE/bug_report.md b/template/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: 'Type: Bug'
+assignees: blackfalcon
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.
diff --git a/template/.github/ISSUE_TEMPLATE/config.yml b/template/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1 @@
+blank_issues_enabled: false
diff --git a/template/.github/ISSUE_TEMPLATE/feature_request.md b/template/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: 'Type: Feature'
+assignees: blackfalcon
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.
diff --git a/template/.github/ISSUE_TEMPLATE/general-support.md b/template/.github/ISSUE_TEMPLATE/general-support.md
@@ -0,0 +1,30 @@
+---
+name: General support
+about: Suggestions that are not related to bugs or new features
+title: ''
+labels: 'Type: Question'
+assignees: blackfalcon
+
+---
+
+# General Support Request
+<!---  The scope of this request is to neither communicate a bug or feature request.  -->
+<!---  If this is a bug or feature request, please close this issue and reference the previus templates.  -->
+
+## Support request
+<!--- Please describe the issue you are reporting -->
+
+## Possible Solution
+<!--- Not obligatory, but suggest a fix/reason for the bug, -->
+<!--- or ideas how to implement the addition or change -->
+
+## Context
+<!--- How has this issue affected you? What are you trying to accomplish? -->
+<!--- Providing context helps us come up with a solution that is most useful in the real world -->
+
+## Your Environment
+<!--- Include as many relevant details about the environment you experienced the bug in -->
+* Version used:
+* Browser Name and version:
+* Operating System and version (desktop or mobile):
+* Link to your project: