diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 00000000..3daa6de0 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,22 @@ +# Contributing to Pico + +Thanks for your interest in contributing to Pico CSS! Please take a moment to review this document before submitting a [bug report](https://github.com/picocss/pico/issues) or a [pull request](https://github.com/picocss/pico/pulls). + +## Bug reports + +The [issue tracker]((https://github.com/picocss/pico/issues)) is the preferred channel for bug reports, but please respect the following restrictions: +- Please do not use the issue tracker for personal support requests. [Open a question in our discussion forums](https://github.com/picocss/pico/discussions/discussions/new?category=help) instead. +- Please do not use the issue tracker for feature requests. [Suggest any ideas you have using our discussion forums](https://github.com/picocss/pico/discussions/discussions/new?category=ideas) instead. + +## Pull requests + +Good pull requests, patches, improvements, and new features are a fantastic help. + +**Please ask first before starting work on any significant new features.** +We recommend that you first [suggest your feature idea in our discussion forums](https://github.com/picocss/pico/discussions/discussions/new?category=ideas). + +[`dev`](https://github.com/picocss/pico/tree/dev) branch is open to pull requests. + +**Do not edit [`/css`](https://github.com/picocss/pico/tree/master/css) files directly.** Edit the source files in [`/scss`](https://github.com/picocss/pico/tree/master/scss), then recompile the [`/css`](https://github.com/picocss/pico/tree/master/css) files with `npm run build`. + +Do not edit [`/docs/*.html`](https://github.com/picocss/pico/tree/master/docs) files directly. Edit the source files in [`/docs/src`](https://github.com/picocss/pico/tree/master/docs/src), then recompile the docs files with `npm run build`. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/01_bug_report.md b/.github/ISSUE_TEMPLATE/01_bug_report.md deleted file mode 100644 index b7b6cb19..00000000 --- a/.github/ISSUE_TEMPLATE/01_bug_report.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -name: πŸ› Bug -about: Report a bug/issue - ---- - - - -## Describe the issue - -### Current Behavior: - - -### Expected Behavior: - - -### Steps To Reproduce: - - -### Environment: - - -### Anything else: - diff --git a/.github/ISSUE_TEMPLATE/02_feature_request.md b/.github/ISSUE_TEMPLATE/02_feature_request.md deleted file mode 100644 index 02a7ec5b..00000000 --- a/.github/ISSUE_TEMPLATE/02_feature_request.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -name: πŸš€ Feature request -about: If you have a feature request πŸ’‘ - ---- - -## Context - -What are you trying to do and how would you want to do it differently? Is it something you currently you cannot do? Is this related to an issue/problem? - -## Alternatives - -Can you achieve the same result doing it in an alternative way? Is the alternative considerable? - -## If the feature request is approved, would you be willing to submit a PR? - -Yes / No _(Help can be provided if you need assistance submitting a PR)_ diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..059b6870 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,21 @@ +--- +name: Bug report +about: If you've already asked for help with a problem and confirmed something is broken with Pico CSS, create a bug report. +--- + +Please search for duplicate or closed issues first. + +## Describe the issue + +### Current Behavior +A concise description of the bug. + +### Expected Behavior +A concise description of what you expected. + +### Reproduction URL +We recommend including a link to a minimal reproduction of the bug using CodePen or a similar tool. +**Please do not link to your actual project**, what we need instead is a reduced test case in a fresh project without any unnecessary code. + +### Environment +Example: OS, versions, browser details. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..6cabc57b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false +contact_links: + - name: Get Help + url: https://github.com/picocss/pico/discussions/discussions/new?category=help + about: If you can't get something to work the way you expect, open a question in our discussion forums. + - name: Feature Request + url: https://github.com/picocss/pico/discussions/discussions/new?category=ideas + about: Suggest any ideas you have using our discussion forums. \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index f0641253..00000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,5 +0,0 @@ -## Contributing - -- [`dev`](https://github.com/picocss/pico/tree/dev) branch is open to pull requests. -- Do not edit [`/css`](https://github.com/picocss/pico/tree/master/css) files directly. Edit the source files in [`/scss`](https://github.com/picocss/pico/tree/master/scss), then recompile the [`/css`](https://github.com/picocss/pico/tree/master/css) files with `npm run build`. -- Do not edit [`/docs/*.html`](https://github.com/picocss/pico/tree/master/docs) files directly. Edit the source files in [`/docs/src`](https://github.com/picocss/pico/tree/master/docs/src), then recompile the docs files with `npm run build`. diff --git a/README.md b/README.md index 91979e27..25e985d4 100644 --- a/README.md +++ b/README.md @@ -172,9 +172,7 @@ Pico can be used without custom CSS for quick or small projects. However, it’s ## Contributing -- [`dev`](https://github.com/picocss/pico/tree/dev) branch is open to pull requests. -- Do not edit [`/css`](https://github.com/picocss/pico/tree/master/css) files directly. Edit the source files in [`/scss`](https://github.com/picocss/pico/tree/master/scss), then recompile the [`/css`](https://github.com/picocss/pico/tree/master/css) files with `npm run build`. -- Do not edit [`/docs/*.html`](https://github.com/picocss/pico/tree/master/docs) files directly. Edit the source files in [`/docs/src`](https://github.com/picocss/pico/tree/master/docs/src), then recompile the docs files with `npm run build`. +If you are interested in contributing to Pico CSS, please read our [contributing guidelines](https://github.com/picocss/pico/blob/master/.github/CONTRIBUTING.md). ## Copyright and license