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/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..38402ed2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,21 @@ +--- +name: Bug report +about: Create a bug report if you've already asked for help with a problem and confirmed something is broken with Pico CSS. +--- + +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.** Instead, we need a reduced test case in a new 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/README.md b/README.md index f69d6cc7..03c3b0cb 100644 --- a/README.md +++ b/README.md @@ -177,9 +177,7 @@ Pico can be used without custom CSS for quick or small projects. However, it’s Pico is designed and tested for the latest stable Chrome, Firefox, Edge, and Safari releases. It does not support any version of IE, including IE 11. ## 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