mirror of
https://github.com/picocss/pico.git
synced 2025-04-20 08:45:06 -04:00
chore: Edit contributing guidelines
This commit is contained in:
parent
0699a1dcac
commit
c107a7b049
7 changed files with 52 additions and 55 deletions
22
.github/CONTRIBUTING.md
vendored
Normal file
22
.github/CONTRIBUTING.md
vendored
Normal file
|
@ -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`.
|
30
.github/ISSUE_TEMPLATE/01_bug_report.md
vendored
30
.github/ISSUE_TEMPLATE/01_bug_report.md
vendored
|
@ -1,30 +0,0 @@
|
|||
---
|
||||
name: 🐛 Bug
|
||||
about: Report a bug/issue
|
||||
|
||||
---
|
||||
|
||||
<!-- Note: Please search to see if an issue already exists for the bug you encountered. -->
|
||||
|
||||
## Describe the issue
|
||||
|
||||
### Current Behavior:
|
||||
<!-- A concise description of what you're experiencing. -->
|
||||
|
||||
### Expected Behavior:
|
||||
<!-- A concise description of what you expected to happen. -->
|
||||
|
||||
### Steps To Reproduce:
|
||||
<!--
|
||||
Example: steps to reproduce the behavior:
|
||||
1. In this environment...
|
||||
2. With this config...
|
||||
3. Run '...'
|
||||
4. See error...
|
||||
-->
|
||||
|
||||
### Environment:
|
||||
<!-- Example: OS, versions, browser details etc. -->
|
||||
|
||||
### Anything else:
|
||||
<!-- Links? Potential Fixes? References? Anything that will give us more context about the issue that you are encountering! -->
|
17
.github/ISSUE_TEMPLATE/02_feature_request.md
vendored
17
.github/ISSUE_TEMPLATE/02_feature_request.md
vendored
|
@ -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)_
|
21
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
21
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
|
@ -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.
|
8
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
8
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
|
@ -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.
|
|
@ -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`.
|
|
@ -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
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue