diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..f7cce9d --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,17 @@ +# Contributing to Cobalt2 Theme + +### Make changes to the Cobalt2 theme or docs + +To work on the theme: + +1. Clone this repo and open in VS Code +2. Open run `View → Run` +3. Click `Launch Extension`. This will open up another VS Code Editor +4. Make changes to `cobalt2.json`. You will see changes reflected in the other editor that opened in step 3. + +If you are making a Pull Request, Please give me a screenshot of before/after! + +### Submit bug reports or feature requests + +For bug reports or feature requests, please utilize the GitHub issue tracker.
+If you are submitting a bug report, please follow the [issue template](https://github.com/wesbos/cobalt2-vscode/issues/new). \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..ab23b60 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,15 @@ +## Description + +Provide a detailed and clear description of the issue you are encountering, including any relevant context or background information. + +## Expected Behavior + +Explain the expected behavior or outcome when the issue is resolved. This should include a clear understanding of what success looks like for this particular problem. + +## Screenshots + +If applicable, include screenshots to help illustrate the issue. Ensure that any screenshots provided are clear, relevant, and properly annotated to highlight the problem. + +## Additional Information + +Include any additional information that may be relevant to understanding or resolving the issue. \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..6346f63 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,26 @@ +## Proposed changes + +Provide a detailed description of the changes included in this pull request. Explain the purpose and impact of the changes, including any relevant context or background information. + +If the pull request addresses a specific issue or feature request, be sure to reference it here by linking to the relevant issue. + +Fixes # (issue) + +## Screenshots + +Include screenshots to demonstrate the changes made by this pull request. This include before-and-after comparisons or specific examples of the modified functionality. + +### Before + + +### After + + +## Checklist + +Before submitting this pull request, ensure that you have completed the following tasks:
+(_Put an `x` in the boxes that apply._) + +- [ ] I have read and understood the [CONTRIBUTING](https://github.com/wesbos/cobalt2-vscode/blob/master/.github/CONTRIBUTING.md) guidelines. +- [ ] I have performed a self-review of my code. +- [ ] I have added relevant screenshots or visual aids to showcase the changes made by this pull request. \ No newline at end of file diff --git a/.github/labeler.yml b/.github/labeler.yml new file mode 100644 index 0000000..c03c05f --- /dev/null +++ b/.github/labeler.yml @@ -0,0 +1,28 @@ +version: v1 + +labels: + - label: "Enhancement" + sync: true + matcher: + commits: "^feat.*?:" + title: "^feat.*?:" + + - label: "Bug" + sync: true + matcher: + commits: "^fix.*?:" + title: "^fix.*?:" + + - label: "Documentation" + sync: true + matcher: + commits: "^docs.*?:" + title: "^docs.*?:" + files: ["demo/**", "**/*.md"] + + - label: "Chore" + sync: true + matcher: + commits: "^chore.*?:" + title: "^chore.*?:" + files: [".github/**", ".vscode/**", "./.*", "./*.js"]