diff --git a/.github/actions/spelling/allow.txt b/.github/actions/spelling/allow.txt index b162377691..e945978bd8 100644 --- a/.github/actions/spelling/allow.txt +++ b/.github/actions/spelling/allow.txt @@ -223,6 +223,7 @@ iperf ipsec iptables irssi +ISSUENUMBER itertools iucode jack diff --git a/doc/new-contributor-tips.md b/doc/new-contributor-tips.md new file mode 100644 index 0000000000..e669efd36c --- /dev/null +++ b/doc/new-contributor-tips.md @@ -0,0 +1,9 @@ +This file contains the tips/links I put into bugs marked "good first issue" so +that new contributors have the guidance they need right in the bug. + +**Short tips for new contributors:** +* [cve-bin-tool's contributor docs](https://github.com/intel/cve-bin-tool/blob/main/CONTRIBUTING.md) +* If you've contributed to open source but not this project, you might just want our [checklist for a great pull request](https://github.com/intel/cve-bin-tool/blob/main/CONTRIBUTING.md#checklist-for-a-great-pull-request) +* cve-bin-tool uses https://www.conventionalcommits.org/ style for commit messages, and we have a test that checks the title of your PR. A good potential title for this one is in the title of this issue. +* You can make an issue auto close by including a comment "fixes #ISSUENUMBER" in your PR comments where ISSUENUMBER is the actual number of the issue. +