mirror of
https://github.com/sobolevn/git-secret
synced 2024-11-08 19:10:31 +00:00
6188d14539
* code style in CONTRIBUTING.md and PR template * make link to CONTRIBUTING.md in .github/PULL_REQUEST_TEMPLATE.md * mention shellcheck and 'make lint' * mention that you should update CHANGELOG.md * mention spellchecking with aspell * more spelling fixes * add to CHANGELOG about style guide/dev philosophy * remind contributors to update .ronn file/man page
33 lines
1.5 KiB
Markdown
33 lines
1.5 KiB
Markdown
<!-- Thanks for sending a pull request!
|
||
|
||
Here's how it's done:
|
||
0. If you are planning a large feature, please, discuss it first in a separate issue.
|
||
See also [CONTRIBUTING.md](https://github.com/sobolevn/git-secret/blob/master/CONTRIBUTING.md) if you haven't already.
|
||
1. Make sure that you open your pull request against the `master` branch
|
||
2. Make sure that your code has the same style as the surrounding code and git-secret in general
|
||
3. Make sure your code passes using `shellcheck` with `make lint`
|
||
4. You can also spell check your code using 'aspell -c {filename}'
|
||
5. If you are adding or changing features, please add tests that cover the new behavior (in addition to the unchanged behavior if appropriate)
|
||
6. Make sure that all tests pass
|
||
7. Change the .ronn file(s) in man/man*/ to document your changes if appropriate
|
||
(regenerating man pages with 'make build-man' is optional)
|
||
8. Add an entry to CHANGELOG.md explaining the change briefly and, if appropriate, referring to the related issue #
|
||
|
||
Please make sure you click the link above to view the contribution guidelines, then fill out the blanks below. -->
|
||
|
||
What does this implement/fix? Explain your changes.
|
||
---------------------------------------------------
|
||
…
|
||
|
||
Does this close any currently open issues?
|
||
------------------------------------------
|
||
…
|
||
|
||
Any relevant logs, error output, etc?
|
||
-------------------------------------
|
||
(If it’s long, please paste to https://ghostbin.com/ and insert the link here.)
|
||
|
||
Any other comments?
|
||
-------------------
|
||
…
|