mirror of
https://github.com/jekyll/jekyll.git
synced 2026-04-28 03:01:03 -04:00
Add more issue template(s) and pull request template (#7269)
Merge pull request 7269
This commit is contained in:
67
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
67
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
@@ -0,0 +1,67 @@
|
||||
---
|
||||
name: Bug Report
|
||||
about: Is something not working as expected?
|
||||
---
|
||||
|
||||
<!--
|
||||
Hi! Thanks for considering to file a bug with Jekyll. Please take the time to
|
||||
answer the basic questions. Please try to be as detailed as possible.
|
||||
|
||||
If you are unsure this is a bug in Jekyll, or this is a bug caused
|
||||
by a plugin that isn't directly related to Jekyll, or if this is just
|
||||
a generic usage question, please consider asking your question at
|
||||
https://talk.jekyllrb.com where non-bug questions go.
|
||||
|
||||
Thanks!
|
||||
-->
|
||||
|
||||
<!--
|
||||
Make sure that you've done all of these. If you're sure that the bug you're
|
||||
reporting is only apparent in a previous version of Jekyll, please say so explicitly
|
||||
in your description.
|
||||
|
||||
- I updated to the latest Jekyll (or) if on GitHub Pages to the latest `github-pages`
|
||||
- I ran `jekyll doctor` to check my configuration
|
||||
- I read the contributing document at https://jekyllrb.com/docs/contributing/
|
||||
-->
|
||||
|
||||
## My Environment
|
||||
|
||||
<!--
|
||||
Replace the values in the Version(s) column with the ones in your build. If you're not
|
||||
using `github-pages`, just replace it with "No".
|
||||
-->
|
||||
|
||||
| Software | Version(s) |
|
||||
| ---------------- | ---------- |
|
||||
| Operating System | |
|
||||
| `jekyll` | Latest |
|
||||
| `github-pages` | Latest |
|
||||
|
||||
---
|
||||
|
||||
## Expected Behaviour
|
||||
|
||||
<!--
|
||||
What is it you expected to happen? This should be a description of how the
|
||||
functionality you tried to use is supposed to work.
|
||||
-->
|
||||
|
||||
## Current Behavior
|
||||
|
||||
<!--
|
||||
Describe the details of the bug. Be sure to include any steps you took for the
|
||||
problem to exist, such as the directories you created and the full command
|
||||
you ran. Include any plugins you have installed (this is very important!).
|
||||
|
||||
You can include any logs you think relevant here. If you're using GitHub pages
|
||||
and you're not sure where your logs are, please email support@github.com and
|
||||
they will happily help you.
|
||||
-->
|
||||
|
||||
## Code Sample
|
||||
|
||||
<!--
|
||||
Please provide a code repository, gist, code snippet or sample files to
|
||||
reproduce the issue.
|
||||
-->
|
||||
69
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
69
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
@@ -0,0 +1,69 @@
|
||||
---
|
||||
name: Feature Request
|
||||
about: Want us to add any features to Jekyll?
|
||||
---
|
||||
|
||||
<!--
|
||||
Hi! Thanks for considering to file a feature request with Jekyll. Please take the time to
|
||||
answer the basic questions. Please try to be as detailed as possible.
|
||||
|
||||
Thanks!
|
||||
-->
|
||||
|
||||
## Summary
|
||||
|
||||
<!--
|
||||
A one-paragraph explanation of the feature.
|
||||
-->
|
||||
|
||||
## Motivation
|
||||
|
||||
<!--
|
||||
Why do you want to see this feature in Jekyll? What makes you sure that it should not be
|
||||
implemented at the plugin level, but in Jekyll core? What use cases does it support?
|
||||
|
||||
NOTE: Please be mindful of the Jekyll philosophy (https://jekyllrb.com/philosophy/),
|
||||
particularily Section 5. Think about if 90% of the users would benefit from your
|
||||
feature request, and whether your feature would be better off in a plugin.
|
||||
-->
|
||||
|
||||
## Guide-level explanation
|
||||
|
||||
<!--
|
||||
Explain the proposal as if it was already included in the project and you
|
||||
were teaching it to another programmer. That generally means:
|
||||
|
||||
- Introducing new named concepts.
|
||||
- Explaining the feature largely in terms of examples.
|
||||
- If applicable, provide sample error messages, deprecation warnings, or
|
||||
migration guidance.
|
||||
|
||||
If this is a small feature, you may omit this section.
|
||||
-->
|
||||
|
||||
## Reference-level explanation
|
||||
|
||||
<!--
|
||||
This is the technical portion of the feature request. Explain the design in
|
||||
sufficient detail that:
|
||||
|
||||
- Its interaction with other features is clear.
|
||||
- It is reasonably clear how the feature would be implemented.
|
||||
- Corner cases are dissected by example.
|
||||
|
||||
If you do not know how to answer this, you can omit it. No worries!
|
||||
-->
|
||||
|
||||
## Drawbacks
|
||||
|
||||
<!--
|
||||
Why should we *not* do this?
|
||||
-->
|
||||
|
||||
## Unresolved Questions
|
||||
|
||||
<!--
|
||||
What related issues do you consider out of scope for this feature that could be
|
||||
addressed in the future independently of the solution that comes out of this
|
||||
feature?
|
||||
-->
|
||||
11
.github/ISSUE_TEMPLATE/question.md
vendored
Normal file
11
.github/ISSUE_TEMPLATE/question.md
vendored
Normal file
@@ -0,0 +1,11 @@
|
||||
---
|
||||
name: Question
|
||||
about: Have any questions about how Jekyll works?
|
||||
---
|
||||
|
||||
<!--
|
||||
The Jekyll issue tracker IS NOT for usage questions! Please post your
|
||||
question on our dedicated forum at https://talk.jekyllrb.com.
|
||||
|
||||
Thank you!
|
||||
-->
|
||||
Reference in New Issue
Block a user