danog/gojekyll
1
0
Fork 0
mirror of https://github.com/danog/gojekyll.git synced 2025-01-23 00:01:14 +01:00
Code Issues Projects Releases Wiki Activity

Add PR template

Browse Source
This commit is contained in:
Oliver Steele 2017-07-05 14:27:24 -04:00
parent 266c14c798
commit bc99d94531
3 changed files with 22 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
.github/ISSUE_TEMPLATE.md vendored
View File

@ -1,7 +1,8 @@
## Checklist
- [ ] I have searched the [issue list](https://github.com/osteele/gojekyll/issues)
- [ ] I have read the [limitations](https://github.com/osteele/gojekyll#limitations) and [feature status](https://github.com/osteele/gojekyll#feature-status) sections of the README.
Is this a bug in Gojekyll's Liquid template engine? If so, it would better reported, with a Liquid test case, [here](https://github.com/osteele/liquid/issues). If you aren't sure, go ahead and report it against Gojekyll, I'd rather have extra bug reports than not know.
- [ ] This is an't a Go Liquid bug. (If it is, report it [here](https://github.com/osteele/liquid/issues).] Or, I'm not sure or don't know what that means -- in which case go ahead and report it here.
#### System information
@ -16,10 +17,13 @@ Commit hash: (if version = `develop`)
#### Steps to reproduce the behavior
Provide the highest of these that is practical:
Provide the first of these that is practical:
1. A Go test case. You're a hero!
1. A Go test case function.
2. A single file that demonstrates the problem. Put this in a directory and run `gojekyll -s path/to/directory`, and we'll see the issue.
3. A two-file site that demonstrates the problem. Put the `_config.yml` and the other document in a directory, etc.
4. A link to a repo that demonstrates the problem.
5. Something is wrong but I don't have time or knowledge to fully isolate it. Here's the best description I can provide.
## Possible Solution

8
.github/PULL_REQUEST_TEMPLATE.md vendored Normal file
View File

@ -0,0 +1,8 @@
## Checklist
- [ ] I have read the contribution guidelines.
- [ ] `make test` passes.
- [ ] `make lint` passes.
- [ ] New and changed code is covered by tests.
- [ ] Performance improvements include benchmarks.
- [ ] Changes match the *documented* (not just the *implemented*) behavior of Jekyll.

10
CONTRIBUTING.md
View File

@ -1,11 +1,13 @@
# Contributing
Refer to the [Liquid contribution guidelines](https://github.com/Shopify/liquid/blob/master/CONTRIBUTING.md).
Here's some ways to help:
In addition to those checklists, I also won't merge:
* Try it on your site. Use this as fodder for test cases.
* Pick an un-checked item from [Status](https://github.com/osteele/gojekyll#feature-status). Let me know you want to work on it – I have ideas for some of these.
* Search the source for FIXME and TODO.
* Improve the [code coverage](https://coveralls.io/github/osteele/gojekyll?branch=master).
- [ ] Performance improvements that don't include a benchmark.
- [ ] Meager (<3%) performance improvements that increase code verbosity or complexity.
If you choose to contribute code, please review the [pull request template](https://github.com/osteele/liquid/blob/master/.github/PULL_REQUEST_TEMPLATE.md) before you get too far along.
## Developer Cookbook