diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..97afdcc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,35 @@ +--- +name: Bug report +about: Report a bug to improve this project +title: '' +labels: 'bug' +assignees: '' + +--- + +#### The bug + +A clear and concise description of what the bug is. + +#### Software versions + +A list of software versions where the bug is apparent, as detailed as possible: + +* `setup-beam`: ... +* other (where applicable): ... + +#### How to replicate + +An ordered list of steps to replicate the bug: + +1. run `...` +2. search for `...` in the error output +3. look at file `...` + +#### Expected behaviour + +What's expected to happen when you follow the steps listed above. + +#### Additional context + +Any other context about the bug. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..d20a7a6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,26 @@ +--- +name: Feature request +about: Request a feature for this project +title: '' +labels: 'feature' +assignees: '' + +--- + +#### Is your feature request related to a problem? + +A clear and concise description of what the problem is, e.g. "I'm always frustrated +when ..." + +#### Describe the feature you'd like + +A clear and concise description of what you want to happen after the new feature +is implemented. + +#### Describe alternatives you've considered + +A clear and concise description of any alternative solutions or features you've considered. + +#### Additional context + +Any other context about the feature request. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..8930657 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,8 @@ +# Description + +A brief description of your changes. + +Closes #<issue>. + +- [ ] I have performed a self-review of my changes +- [ ] I have read and understood the [contributing guidelines](/erlef/setup-beam/blob/main/CONTRIBUTING.md) diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..5d93427 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,34 @@ +# Security policy + +Thanks for helping make `setup-beam` safer for everyone. + +Find below updated information on our security policy. + +## Security + +We take the security of this software seriously. + +We don't implement a bug bounty program or bounty rewards, but will work with +you closed to ensure that your findings gets the appropriate handling. + +## Reporting Security Issues + +If you believe you have found a security vulnerability in this repository, +please report it to . + +Please do not report security vulnerabilities through public channels, like +GitHub issues, discussions, or pull requests. + +Please include as much of the information listed below as you can to help us +better understand and resolve the issue: + +- the type of issue (e.g., buffer overflow, SQL injection, or cross-site + scripting) +- full paths of source file(s) related to the manifestation of the issue +- the location of the affected source code (tag/branch/commit or direct URL) +- any special configuration required to reproduce the issue +- step-by-step instructions to reproduce the issue +- proof-of-concept or exploit code (if possible) +- impact of the issue, including how an attacker might exploit the issue + +This information will help us triage your report more quickly. diff --git a/package.json b/package.json index 33c301f..3e02425 100644 --- a/package.json +++ b/package.json @@ -7,7 +7,7 @@ "format": "prettier src/**/*.js --write && prettier test/**/*.js --write", "jslint": "eslint src/**/*.js && eslint test/**/*.js", "licenses": "yarn licenses generate-disclaimer > 3RD_PARTY_LICENSES", - "markdownlint": "markdownlint *.md", + "markdownlint": "markdownlint *.md ./github/**/*.md", "shellcheck": "shellcheck src/install-*.sh .github/workflows/*.sh", "test": "node test/setup-beam.test.js && node ./test/problem-matchers.test.js", "yamllint": "yamllint .github/workflows/**.yml && yamllint .*.yml && yamllint *.yml",