neiam /action-setup-beam
action-setup-beam
public · Issues · Pulls · Labels · Forks · Compare · Actions queued
⭐
Log in to mark this repository.
Improve our community standards (#218)
fa5c1c2 · Paulo F. Oliveira · 2023-07-01 16:26
Message
{commit_body(@commit)}
Files changed
added
.github/ISSUE_TEMPLATE/bug_report.md
+35
−0
@@ -0,0 +1,35 @@
| 1 | +--- | |
| 2 | +name: Bug report | |
| 3 | +about: Report a bug to improve this project | |
| 4 | +title: '' | |
| 5 | +labels: 'bug' | |
| 6 | +assignees: '' | |
| 7 | + | |
| 8 | +--- | |
| 9 | + | |
| 10 | +#### The bug | |
| 11 | + | |
| 12 | +A clear and concise description of what the bug is. | |
| 13 | + | |
| 14 | +#### Software versions | |
| 15 | + | |
| 16 | +A list of software versions where the bug is apparent, as detailed as possible: | |
| 17 | + | |
| 18 | +* `setup-beam`: ... | |
| 19 | +* other (where applicable): ... | |
| 20 | + | |
| 21 | +#### How to replicate | |
| 22 | + | |
| 23 | +An ordered list of steps to replicate the bug: | |
| 24 | + | |
| 25 | +1. run `...` | |
| 26 | +2. search for `...` in the error output | |
| 27 | +3. look at file `...` | |
| 28 | + | |
| 29 | +#### Expected behaviour | |
| 30 | + | |
| 31 | +What's expected to happen when you follow the steps listed above. | |
| 32 | + | |
| 33 | +#### Additional context | |
| 34 | + | |
| 35 | +Any other context about the bug. |
added
.github/ISSUE_TEMPLATE/feature_request.md
+26
−0
@@ -0,0 +1,26 @@
| 1 | +--- | |
| 2 | +name: Feature request | |
| 3 | +about: Request a feature for this project | |
| 4 | +title: '' | |
| 5 | +labels: 'feature' | |
| 6 | +assignees: '' | |
| 7 | + | |
| 8 | +--- | |
| 9 | + | |
| 10 | +#### Is your feature request related to a problem? | |
| 11 | + | |
| 12 | +A clear and concise description of what the problem is, e.g. "I'm always frustrated | |
| 13 | +when ..." | |
| 14 | + | |
| 15 | +#### Describe the feature you'd like | |
| 16 | + | |
| 17 | +A clear and concise description of what you want to happen after the new feature | |
| 18 | +is implemented. | |
| 19 | + | |
| 20 | +#### Describe alternatives you've considered | |
| 21 | + | |
| 22 | +A clear and concise description of any alternative solutions or features you've considered. | |
| 23 | + | |
| 24 | +#### Additional context | |
| 25 | + | |
| 26 | +Any other context about the feature request. |
added
.github/pull_request_template.md
+8
−0
@@ -0,0 +1,8 @@
| 1 | +# Description | |
| 2 | + | |
| 3 | +A brief description of your changes. | |
| 4 | + | |
| 5 | +Closes #<issue>. | |
| 6 | + | |
| 7 | +- [ ] I have performed a self-review of my changes | |
| 8 | +- [ ] I have read and understood the [contributing guidelines](/erlef/setup-beam/blob/main/CONTRIBUTING.md) |
added
SECURITY.md
+34
−0
@@ -0,0 +1,34 @@
| 1 | +# Security policy | |
| 2 | + | |
| 3 | +Thanks for helping make `setup-beam` safer for everyone. | |
| 4 | + | |
| 5 | +Find below updated information on our security policy. | |
| 6 | + | |
| 7 | +## Security | |
| 8 | + | |
| 9 | +We take the security of this software seriously. | |
| 10 | + | |
| 11 | +We don't implement a bug bounty program or bounty rewards, but will work with | |
| 12 | +you closed to ensure that your findings gets the appropriate handling. | |
| 13 | + | |
| 14 | +## Reporting Security Issues | |
| 15 | + | |
| 16 | +If you believe you have found a security vulnerability in this repository, | |
| 17 | +please report it to <bryan.paxton@erlef.org>. | |
| 18 | + | |
| 19 | +Please do not report security vulnerabilities through public channels, like | |
| 20 | +GitHub issues, discussions, or pull requests. | |
| 21 | + | |
| 22 | +Please include as much of the information listed below as you can to help us | |
| 23 | +better understand and resolve the issue: | |
| 24 | + | |
| 25 | +- the type of issue (e.g., buffer overflow, SQL injection, or cross-site | |
| 26 | + scripting) | |
| 27 | +- full paths of source file(s) related to the manifestation of the issue | |
| 28 | +- the location of the affected source code (tag/branch/commit or direct URL) | |
| 29 | +- any special configuration required to reproduce the issue | |
| 30 | +- step-by-step instructions to reproduce the issue | |
| 31 | +- proof-of-concept or exploit code (if possible) | |
| 32 | +- impact of the issue, including how an attacker might exploit the issue | |
| 33 | + | |
| 34 | +This information will help us triage your report more quickly. |
modified
package.json
+1
−1
@@ -7,7 +7,7 @@
| 7 | 7 | "format": "prettier src/**/*.js --write && prettier test/**/*.js --write", |
| 8 | 8 | "jslint": "eslint src/**/*.js && eslint test/**/*.js", |
| 9 | 9 | "licenses": "yarn licenses generate-disclaimer > 3RD_PARTY_LICENSES", |
| 10 | − "markdownlint": "markdownlint *.md", | |
| 10 | + "markdownlint": "markdownlint *.md ./github/**/*.md", | |
| 11 | 11 | "shellcheck": "shellcheck src/install-*.sh .github/workflows/*.sh", |
| 12 | 12 | "test": "node test/setup-beam.test.js && node ./test/problem-matchers.test.js", |
| 13 | 13 | "yamllint": "yamllint .github/workflows/**.yml && yamllint .*.yml && yamllint *.yml", |
Parents: 7960f20