[Reviews] Adding templates for github and CONTRIBUTING.md #37
Conversation
- CONTRIBUTING.md - CODE_OF_CONDUCT.md - .github/ directory FullSemver: 0.4.1-meta-add-templates-github.1+66 Branch: meta/add-templates-github
FullSemver: 0.4.1-meta-add-templates-github.1+66 Branch: meta/add-templates-github
FullSemver: 0.4.1-meta-add-templates-github.1+67 Branch: meta/add-templates-github
CONTRIBUTING.md
Outdated
| - https://lists.gnu.org/archive/html/bug-bash/2012-06/msg00068.html | ||
| - ftp://ftp.gnu.org/gnu/bash/bash-4.2-patches/bash42-025 | ||
| - http://lists.gnu.org/archive/html/help-bash/2012-03/msg00078.html | ||
|
|
There was a problem hiding this comment.
could add ShellCheck hint?
- [ShellCheck](https://www.shellcheck.net/) can help to identify many of these issues
- uses Bash and BATS as project names - minor markdown formatting changes
|
@mbland's style guide looks like a great place to start. I've PR'd some minor tweaks to @btamayo's branch in btamayo#2, and there's a question above of whether we like ShellCheck enough to add a link to it (there are lots of plugins for IDEs, I think it's marvellous). Apart from that it's all good AFAICS. |
|
Pending a merge of minor changes to the source branch of this PR it's good to merge IMO. And in the interest of https://github.com/bats-core/bats-core/milestone/1 I'm inclined to merge it this week regardless unless @mbland or @jasonkarns feel otherwise? 😄 |
|
no objection |
CONTRIBUTING.md
Outdated
| 2. DO add information if you're facing a similiar issue as someone else, but | ||
| within a different context (e.g. different steps needed to reproduce the issue | ||
| than previous stated, different version of bash or bats, different OS, etc.) | ||
| You can read on how to do that here: [Information to include][#information-to-include] |
There was a problem hiding this comment.
The "Information to include" section is missing. Did you mean to add it?
Consistent naming, minor markdown tweaks, add sublimino
Meta/add templates GitHub
Wanted to open this PR since there's some items like the Formatting section and Code Conventions that we should probably look over.
@mbland Thanks so much for letting us use your original CONTRIBUTING.md from https://github.com/mbland/go-script-bash. Please feel free to update as you see fit, remove/add sections, change wording, etc.
The diff for the two documents is here.
I personally don't have much experience with golang. I trimmed the bits that pertained to go, but if it's applicable please tell me and I'll add it back. :) I also tried to be slightly more brief to anticipate added sections later.
This closes #12.