Skip to content

Commit

Permalink
Improve our community standards (#218)
Browse files Browse the repository at this point in the history
* Add a bug report template

* Add a feature request template

* Add a pull request template

* Add a security policy

* Lint newer files
  • Loading branch information
paulo-ferraz-oliveira committed Jul 1, 2023
1 parent 7960f20 commit fa5c1c2
Show file tree
Hide file tree
Showing 5 changed files with 104 additions and 1 deletion.
35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -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.
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -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.
8 changes: 8 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -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)
34 changes: 34 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -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 <bryan.paxton@erlef.org>.

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.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down

0 comments on commit fa5c1c2

Please sign in to comment.