Browse Source

chore: Add bitwarden/template repo config files (#310)

* Add bitwarden/template files

* Add bug template
pull/314/head
Álison Fernandes 1 year ago committed by GitHub
parent
commit
8efb41e361
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
  1. 18
      .editorconfig
  2. 1
      .gitattributes
  3. 92
      .github/ISSUE_TEMPLATE/bug.yml
  4. 14
      .github/ISSUE_TEMPLATE/config.yml
  5. 35
      .github/PULL_REQUEST_TEMPLATE.md
  6. 23
      .gitignore
  7. 3
      CONTRIBUTING.md
  8. 32
      SECURITY.md

18
.editorconfig

@ -0,0 +1,18 @@ @@ -0,0 +1,18 @@
# EditorConfig is awesome: http://EditorConfig.org
# top-most EditorConfig file
root = true
# Don't use tabs for indentation.
[*]
indent_size = 4
indent_style = space
tab_width = 4
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true
guidelines = 120
[*.{json,yml}]
indent_size = 2

1
.gitattributes vendored

@ -0,0 +1 @@ @@ -0,0 +1 @@
* text=auto eol=lf

92
.github/ISSUE_TEMPLATE/bug.yml

@ -0,0 +1,92 @@ @@ -0,0 +1,92 @@
name: Self-host Release Bug Report
description: File a bug report
labels: [bug]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
> [!WARNING]
> This repository only tracks installation scripts for our self-host project. For any other Bitwarden Server issues including Bitwarden Unified, please submit your report in [bitwarden/server](https://github.com/bitwarden/server)
Please do not submit feature requests. The [Community Forums](https://community.bitwarden.com) has a section for submitting, voting for, and discussing product feature requests.
- type: checkboxes
id: self-host-scripts
attributes:
label: Self-host installation scripts issue
description: "This repository only tracks installation scripts for our self-host project, any other Bitwarden Server issues including Bitwarden Unified should be reported in [bitwarden/server](https://github.com/bitwarden/server)"
options:
- label: "I understand this repository only tracks self-host installation scripts and any other issues should be reported in bitwarden/server"
required: true
- type: textarea
id: reproduce
attributes:
label: Steps To Reproduce
description: How can we reproduce the behavior.
value: |
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. Click on '...'
validations:
required: true
- type: textarea
id: expected
attributes:
label: Expected Result
description: A clear and concise description of what you expected to happen.
validations:
required: true
- type: textarea
id: actual
attributes:
label: Actual Result
description: A clear and concise description of what is happening.
validations:
required: true
- type: textarea
id: screenshots
attributes:
label: Screenshots or Videos
description: If applicable, add screenshots and/or a short video to help explain your problem.
- type: textarea
id: additional-context
attributes:
label: Additional Context
description: Add any other context about the problem here.
- type: input
id: version
attributes:
label: Build Version
description: What version of our software are you running?
validations:
required: true
- type: dropdown
id: environment
attributes:
label: Environment
description: Which environment (Cloud / Self-Hosted) are you using?
multiple: true
options:
- Cloud (bitwarden.com)
- Self-Hosted
validations:
required: true
- type: textarea
id: environment-details
attributes:
label: Environment Details
description: If Self-Hosted please provide some additional environment details.
placeholder: |
- Operating system: [e.g. Windows 10, Mac OS Catalina]
- Environment: [e.g. Docker, EKS, ECS, K8S]
- Hardware: [e.g. Intel 6-core, 8GB RAM]
- type: checkboxes
id: issue-tracking-info
attributes:
label: Issue Tracking Info
description: |
Issue tracking information
options:
- label: I understand that work is tracked outside of Github. A PR will be linked to this issue should one be opened to address it, but Bitwarden doesn't use fields like "assigned", "milestone", or "project" to track progress.

14
.github/ISSUE_TEMPLATE/config.yml

@ -0,0 +1,14 @@ @@ -0,0 +1,14 @@
blank_issues_enabled: false
contact_links:
- name: Feature Requests
url: https://community.bitwarden.com/c/feature-requests/
about: Request new features using the Community Forums. Please search existing feature requests before making a new one.
- name: Bitwarden Community Forums
url: https://community.bitwarden.com
about: Please visit the community forums for general community discussion, support and the development roadmap.
- name: Customer Support
url: https://bitwarden.com/contact/
about: Please contact our customer support for account issues and general customer support.
- name: Security Issues
url: https://hackerone.com/bitwarden
about: We use HackerOne to manage security disclosures.

35
.github/PULL_REQUEST_TEMPLATE.md

@ -0,0 +1,35 @@ @@ -0,0 +1,35 @@
## 🎟 Tracking
<!-- Paste the link to the Jira or GitHub issue or otherwise describe / point to where this change is coming from. -->
## 📔 Objective
<!-- Describe what the purpose of this PR is, for example what bug you're fixing or new feature you're adding. -->
## 📸 Screenshots
<!-- Required for any UI changes; delete if not applicable. Use fixed width images for better display. -->
## ⏰ Reminders before review
- Contributor guidelines followed
- All formatters and local linters executed and passed
- Written new unit and / or integration tests where applicable
- Protected functional changes with optionality (feature flags)
- Used internationalization (i18n) for all UI strings
- CI builds passed
- Communicated to DevOps any deployment requirements
- Updated any necessary documentation (Confluence, contributing docs) or informed the documentation team
## 🦮 Reviewer guidelines
<!-- Suggested interactions but feel free to use (or not) as you desire! -->
- 👍 (`:+1:`) or similar for great changes
- 📝 (`:memo:`) or ℹ (`:information_source:`) for notes or general info
- ❓ (`:question:`) for questions
- 🤔 (`:thinking:`) or 💭 (`:thought_balloon:`) for more open inquiry that's not quite a confirmed issue and could potentially benefit from discussion
- 🎨 (`:art:`) for suggestions / improvements
- ❌ (`:x:`) or ⚠ (`:warning:`) for more significant problems or concerns needing attention
- 🌱 (`:seedling:`) or ♻ (`:recycle:`) for future improvements or indications of technical debt
- ⛏ (`:pick:`) for minor or nitpick changes

23
.gitignore vendored

@ -1,2 +1,23 @@ @@ -1,2 +1,23 @@
# General
.DS_Store
Thumbs.db
# IDEs and editors
.idea/
.project
.classpath
.c9/
*.launch
.settings/
*.sublime-workspace
# Visual Studio Code
.vscode/*
!.vscode/settings.json
!.vscode/tasks.json
!.vscode/launch.json
!.vscode/extensions.json
.history/*
# Secrets file for act (gh actions local run tool)
.secrets
.secrets

3
CONTRIBUTING.md

@ -0,0 +1,3 @@ @@ -0,0 +1,3 @@
# How to Contribute
Our [Contributing Guidelines](https://contributing.bitwarden.com/contributing/) are located in our [Contributing Documentation](https://contributing.bitwarden.com/). The documentation also includes recommended tooling, code style tips, and lots of other great information to get you started.

32
SECURITY.md

@ -0,0 +1,32 @@ @@ -0,0 +1,32 @@
Bitwarden believes that working with security researchers across the globe is crucial to keeping our
users safe. If you believe you've found a security issue in our product or service, we encourage you
to please submit a report through our [HackerOne Program](https://hackerone.com/bitwarden/). We
welcome working with you to resolve the issue promptly. Thanks in advance!
# Disclosure Policy
- Let us know as soon as possible upon discovery of a potential security issue, and we'll make every
effort to quickly resolve the issue.
- Provide us a reasonable amount of time to resolve the issue before any disclosure to the public or
a third-party. We may publicly disclose the issue before resolving it, if appropriate.
- Make a good faith effort to avoid privacy violations, destruction of data, and interruption or
degradation of our service. Only interact with accounts you own or with explicit permission of the
account holder.
- If you would like to encrypt your report, please use the PGP key with long ID
`0xDE6887086F892325FEC04CC0D847525B6931381F` (available in the public keyserver pool).
While researching, we'd like to ask you to refrain from:
- Denial of service
- Spamming
- Social engineering (including phishing) of Bitwarden staff or contractors
- Any physical attempts against Bitwarden property or data centers
# We want to help you!
If you have something that you feel is close to exploitation, or if you'd like some information
regarding the internal API, or generally have any questions regarding the app that would help in
your efforts, please email us at https://bitwarden.com/contact and ask for that information. As
stated above, Bitwarden wants to help you find issues, and is more than willing to help.
Thank you for helping keep Bitwarden and our users safe!
Loading…
Cancel
Save