Add more issue template(s) and pull request template (#7269)
Merge pull request 7269
This commit is contained in:
liv
jekyllbot
parent
1e81243ef8
commit
d83d3e880e
|
|
@ -1,78 +0,0 @@
|
||||||
<!--
|
|
||||||
Hi! Thanks for considering to file a bug with Jekyll. Please take the time to
|
|
||||||
answer the basic questions. You can convert `[ ]` into `[x]` to check boxes (or submit
|
|
||||||
and check.) If there is no need for certain fields like output and redirection, please delete
|
|
||||||
those headers before submitting. We know not all tickets require those steps.
|
|
||||||
Otherwise, 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!
|
|
||||||
-->
|
|
||||||
|
|
||||||
- [ ] I believe this to be a bug, not a question about using Jekyll.
|
|
||||||
- [ ] 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 CONTRIBUTION file at https://jekyllrb.com/docs/contributing/
|
|
||||||
- [ ] This is a feature request.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
- [ ] I am on (or have tested on) ***macOS*** 10+
|
|
||||||
- [ ] I am on (or have tested on) ***Debian/Ubuntu*** GNU/Linux
|
|
||||||
- [ ] I am on (or have tested on) ***Fedora*** GNU/Linux
|
|
||||||
- [ ] I am on (or have tested on) ***Arch*** GNU/Linux
|
|
||||||
- [ ] I am on (or have tested on) ***Other*** GNU/Linux
|
|
||||||
- [ ] I am on (or have tested on) ***Windows*** 10+
|
|
||||||
|
|
||||||
<!--
|
|
||||||
Other GNU/Linux includes Scientific GNU/Linux, CentOS GNU/Linux, and others.
|
|
||||||
If you are on a minor sub-distro (such as ElementaryOS which does not diverge from
|
|
||||||
Ubuntu much, please check the parent distro. Kubuntu, Edubuntu, Lubuntu should
|
|
||||||
also be flagged as Ubuntu as their packages come from upstream Ubuntu.
|
|
||||||
-->
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
- [ ] I was trying to install.
|
|
||||||
- [ ] There is a broken Plugin API.
|
|
||||||
- [ ] I had an error on GitHub Pages, and I have reproduced it locally.
|
|
||||||
- [ ] I had an error on GitHub Pages, and GitHub Support said it was a Jekyll Bug.
|
|
||||||
- [ ] I had an error on GitHub Pages and I did not test it locally.
|
|
||||||
- [ ] I was trying to build.
|
|
||||||
- [ ] It was another bug.
|
|
||||||
|
|
||||||
## My Reproduction Steps
|
|
||||||
|
|
||||||
<!--
|
|
||||||
If this error occurred on GitHub Pages, please try to provide us with logs,
|
|
||||||
and look at them yourself, to determine if this is an actual Jekyll bug. In
|
|
||||||
the event you are unsure, file a ticket, however, when you do please provide
|
|
||||||
the logs (strip them of personal information.)
|
|
||||||
|
|
||||||
If you have trouble finding your logs, please email support@github.com and
|
|
||||||
they will happily help you. If you cannot find logs, please try your best to
|
|
||||||
replicate it locally because we cannot fix a problem if we do not know
|
|
||||||
exactly what caused it, or within a relatively close distance.
|
|
||||||
-->
|
|
||||||
|
|
||||||
<!--
|
|
||||||
Insert the steps you took to for this problem to exist. Such as the
|
|
||||||
directories you created and, the full command you ran, and include any
|
|
||||||
plugins you have installed, this is very important.
|
|
||||||
|
|
||||||
If your steps are complicated, you can also submit a GitHub
|
|
||||||
repository (please no zips, they will be removed and rejected by maintainers,)
|
|
||||||
and just supply a command for us to reproduce it ourselves.
|
|
||||||
-->
|
|
||||||
|
|
||||||
## The Output I Wanted
|
|
||||||
|
|
||||||
<!--
|
|
||||||
Insert the output from the command. Alter it as little as you can.
|
|
||||||
The minimum should be personal information. Though we normally don't log
|
|
||||||
anything like that so there should be no need to alter it.
|
|
||||||
-->
|
|
||||||
|
|
@ -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.
|
||||||
|
-->
|
||||||
|
|
@ -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?
|
||||||
|
-->
|
||||||
|
|
@ -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!
|
||||||
|
-->
|
||||||
|
|
@ -0,0 +1,43 @@
|
||||||
|
<!--
|
||||||
|
Thanks for creating a Pull Request! Before you submit, please make sure
|
||||||
|
you've done the following:
|
||||||
|
|
||||||
|
- I read the contributing document at https://jekyllrb.com/docs/contributing/
|
||||||
|
-->
|
||||||
|
|
||||||
|
<!--
|
||||||
|
Make our lives easier! Choose one of the following by uncommenting it:
|
||||||
|
-->
|
||||||
|
|
||||||
|
<!-- This is a 🐛 bug fix. -->
|
||||||
|
<!-- This is a 🙋 feature or enhancement. -->
|
||||||
|
<!-- This is a 🔦 documentation change. -->
|
||||||
|
|
||||||
|
<!--
|
||||||
|
Before you submit this pull request, make sure to have a look at the following
|
||||||
|
checklist. If you don't know how to do some of these, that's fine! Submit
|
||||||
|
your pull request and we will help you out on the way.
|
||||||
|
|
||||||
|
- I've added tests (if it's a bug, feature or enhancement)
|
||||||
|
- I've adjusted the documentation (if it's a feature or enhancement)
|
||||||
|
- The test suite passes (run `script/cibuild` to verify this)
|
||||||
|
-->
|
||||||
|
|
||||||
|
## Summary
|
||||||
|
|
||||||
|
<!--
|
||||||
|
Provide a description of what your pull request changes.
|
||||||
|
-->
|
||||||
|
|
||||||
|
## Context
|
||||||
|
|
||||||
|
<!--
|
||||||
|
Is this related to any GitHub issue(s)?
|
||||||
|
-->
|
||||||
|
|
||||||
|
## Semver Changes
|
||||||
|
|
||||||
|
<!--
|
||||||
|
Which semantic version change would you recommend?
|
||||||
|
If you don't know, feel free to omit it.
|
||||||
|
-->
|
||||||
Loading…
Reference in New Issue