mirror of
https://github.com/capistrano/capistrano
synced 2023-03-27 23:21:18 -04:00
Pull request and issue templates for GitHub (#1770)
* Pull request and issue templates for GitHub * Incorporate the existing issue template. * Fix syntax * A stab at a better syntax * Add example test case Gist
This commit is contained in:
parent
d732fa432f
commit
14540bbfee
3 changed files with 45 additions and 21 deletions
19
.github/issue_template.md
vendored
Normal file
19
.github/issue_template.md
vendored
Normal file
|
@ -0,0 +1,19 @@
|
||||||
|
**Important:** GitHub issues are for feature requests or bug reports. The Capistrano team recommends you use [Stack Overflow](http://stackoverflow.com/questions/tagged/capistrano) for general questions. For more details, please see our [contribution policy](https://github.com/capistrano/capistrano/blob/master/CONTRIBUTING.md).
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Steps to reproduce
|
||||||
|
If reasonable, you can help by creating a Capistrano skeleton example project which reproduces the issue you are seeing. You can then upload the individual files to a GitHub Gist or a GitHub project. Others can simply modify the configuration to point at a test server/repository of their own. Often times, an issue is resolved simply by making this test case.
|
||||||
|
|
||||||
|
An example test case is here: https://gist.github.com/will-in-wi/527327e31af30b3eae2068e2965be05b
|
||||||
|
|
||||||
|
### Expected behavior
|
||||||
|
Tell us what should happen
|
||||||
|
|
||||||
|
### Actual behavior
|
||||||
|
Tell us what happens instead
|
||||||
|
|
||||||
|
### System configuration
|
||||||
|
Please link to the output of `cap <stage> doctor` in a GitHub Gist.
|
||||||
|
|
||||||
|
Thanks for helping improve Capistrano!
|
26
.github/pull_request_template.md
vendored
Normal file
26
.github/pull_request_template.md
vendored
Normal file
|
@ -0,0 +1,26 @@
|
||||||
|
### Summary
|
||||||
|
|
||||||
|
(Guidelines for creating a bug report are available
|
||||||
|
here: https://github.com/capistrano/capistrano/blob/master/DEVELOPMENT.md)
|
||||||
|
|
||||||
|
Provide a general description of the code changes in your pull
|
||||||
|
request... were there any bugs you had fixed? If so, mention them. If
|
||||||
|
these bugs have open GitHub issues, be sure to tag them here as well,
|
||||||
|
to keep the conversation linked together.
|
||||||
|
|
||||||
|
### Short checklist
|
||||||
|
|
||||||
|
- [ ] Did you run `bundle exec rubocop -a` to fix linter issues?
|
||||||
|
- [ ] If relevant, did you create a test?
|
||||||
|
- [ ] Did you confirm that the RSpec tests pass?
|
||||||
|
- [ ] If you are fixing a bug or introducing a new feature, did you add a CHANGELOG entry?
|
||||||
|
|
||||||
|
### Other Information
|
||||||
|
|
||||||
|
If there's anything else that's important and relevant to your pull
|
||||||
|
request, mention that information here.
|
||||||
|
|
||||||
|
If you are updating any of the CHANGELOG files or are asked to update the
|
||||||
|
CHANGELOG files by reviewers, please add the CHANGELOG entry at the top of the file where indicated.
|
||||||
|
|
||||||
|
Thanks for helping improve Capistrano!
|
|
@ -1,21 +0,0 @@
|
||||||
**Important:** GitHub issues are for feature requests or bug reports. The Capistrano team recommends you use [Stack Overflow](http://stackoverflow.com/questions/tagged/capistrano) for general questions. For more details, please see our [contribution policy](https://github.com/capistrano/capistrano/blob/master/CONTRIBUTING.md).
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
#### Steps to reproduce
|
|
||||||
|
|
||||||
1. Lorem.
|
|
||||||
2. Ipsum..
|
|
||||||
3. Dolor...
|
|
||||||
|
|
||||||
#### Expected behaviour
|
|
||||||
|
|
||||||
Tell us what should happen
|
|
||||||
|
|
||||||
#### Actual behaviour
|
|
||||||
|
|
||||||
Tell us what happens instead
|
|
||||||
|
|
||||||
#### Your configuration
|
|
||||||
|
|
||||||
Paste Capistrano's `doctor` output here (`cap <stage> doctor`):
|
|
Loading…
Reference in a new issue