Add .github/ templates #172
Conversation
That thing gets interpreted as Markdown and rendered as an h1.
|
@voxpupuli/collaborators Sorry for the wide reach but this is important for all our projects! |
| @@ -93,5 +93,3 @@ If you don't want to have to recreate the virtual machine every time you | |||
| can use `BEAKER_DESTROY=no` and `BEAKER_PROVISION=no`. On the first run you will | |||
| at least need `BEAKER_PROVISION` set to yes (the default). The Vagrantfile | |||
| for the created virtual machines will be in `.vagrant/beaker_vagrant_fies`. | |||
|
|
|||
| # vim: syntax=markdown | |||
There was a problem hiding this comment.
This modeline is valid markdown and hence gets rendered as an h1. If you're having problems with getting .md files to render correctly in vim please add this to your .vimrc instead:
autocmd BufNewFile,BufReadPost *.md set filetype=markdown
daenney
force-pushed
the
templates
branch
3 times, most recently
from
10a3a05 to
042215c
Compare
| - [ ] There is no existing PR that addresses this problem | ||
| - [ ] Mentioned any existing issues in your commit so they get linked and | ||
| closed once this PR gets merged, i.e: `Closes #1554` in te body of a commit | ||
| - [ ] Followed the instructions in the [Contributing](https://github.com/Homebrew/homebrew-core/blob/master/.github/CONTRIBUTING.md) document |
There was a problem hiding this comment.
So obviously this shouldn't point to Homebrew, that's just a link copy-paste, but how do we generate this per repository?
daenney
force-pushed
the
templates
branch
4 times, most recently
from
5cb4cd6 to
99706a0
Compare
|
I'm pleased we are adding this. No concerns from me. Happy to role this out. |
| - [ ] Ran the unit/spec tests and ensured they still pass | ||
| - [ ] Added tests to cover the new behaviour | ||
| - [ ] Updated the documentation to match the changes | ||
| - [ ] Squashed your PR down to a single commit |
There was a problem hiding this comment.
Hi highly disagree. A commit should be a single logical change. But a PR can have multiple changes. We once had a detailed explanation about the commits in the CONTRIBUTING.md but that got removed (does anyone know why?)
There was a problem hiding this comment.
Hence why there is this, at the top of the file:
+If this PR tries to address multiple issues please split the PR out in a new
+PR per feature/issue, unless that's not possible because of how the code builds
+on top of each other. In that case ensure every feature/fix and its associated
+tests and documentation are squashed into a distinct commit.
I believe that covers your concern. I'm happy to move the text around.
|
Should we add a note to |
|
here is the old version of our CONTRIBUTING with the git guidelines https://github.com/virtapi/installimage/blob/master/CONTRIBUTING.md |
|
LGTM! 👍 |
|
|
||
| - [ ] There is no existing PR that addresses this problem | ||
| - [ ] Mentioned any existing issues in your commit so they get linked and | ||
| closed once this PR gets merged, i.e: `Closes #1554` in te body of a commit |
|
@bastelfreak Better this way? |
daenney
force-pushed
the
templates
branch
2 times, most recently
from
8a5dbe8 to
e9b8a04
Compare
|
@daenney take a look at how Chocolatey does the templates - I recommend surrounding this with HTML comment tags so only what you want shows up - I find folks don't actually read the last line that says DELETE this - see https://github.com/chocolatey/choco/issues/new (and look at the preview without changing anything) to get a sense of what I mean and then take a look at the templates at https://github.com/chocolatey/choco/tree/master/.github |
|
@daenney looks good 👍 What do you think about adding the git notes back to CONTRIBUTION.md? |
|
@ferventcoder Oh I like the trick with the HTML comment tag for that section, I'll do that, thanks! |
|
@ferventcoder That is a cool idea! 👍 |
|
I'd take credit for that, but it was @dahlbyk's idea - and a fantastic one at that! |
|
There, I changed the templates around to have less "please remove this" and more "please provide this" instead. The only thing that has a comment block is the PR template |
|
I'm going to go ahead and merge this so we'll have an initial version of this going out the next time people module sync. We can continue to iterate on it through separate PRs. |
Glad to hear it's working well. 😀 |
This moves
CONTRIBUTING.mdto.github/and adds templates for when someone opens an issue or a PR.The wording in all of this is obviously up for discussion, so, discuss!