Initial commit

Co-Authored-By: Oscar Hinton <[email protected]>
Co-Authored-By: Thomas Rittson <[email protected]>
Co-Authored-By: Robyn MacCallum <[email protected]>
Co-Authored-By: Chad Scharf <[email protected]>
Co-Authored-By: Todd Martin <[email protected]>
Co-Authored-By: Jared Snider <[email protected]>
Co-Authored-By: Daniel James Smith <[email protected]>
Co-Authored-By: Justin Baur <[email protected]>
Co-Authored-By: Thomas Avery <[email protected]>
Co-Authored-By: Shane Melton <[email protected]>
Co-Authored-By: Álison Fernandes <[email protected]>
Co-Authored-By: Colton Hurst <[email protected]>

Author: 13 people

.editorconfig

@@ -0,0 +1,19 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+# Set default charset
+[*.{js,ts,scss,html,md}]
+charset = utf-8
+indent_style = space
+indent_size = 2
+
+[*.{ts}]
+quote_type = single

.github/CODEOWNERS

@@ -0,0 +1,6 @@
+# Default code owners
+* @MGibson1 @Hinton
+
+# Leave empty
+docs/docs
+docs/contributing

.github/ISSUE_TEMPLATE/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,3 @@
+## Objective
+
+<!--Describe what the purpose of this PR is.-->

.github/ISSUE_TEMPLATE/config.yml

@@ -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.

.github/ISSUE_TEMPLATE/issue.yml

@@ -0,0 +1,49 @@
+name: 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!
+
+        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: input
+    id: page
+    attributes:
+      label: Page
+      description: Full url of the page where the issue was found.
+    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: 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.

.gitignore

@@ -0,0 +1,20 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

.husky/.gitignore

@@ -0,0 +1 @@
+_

.husky/_/husky.sh

@@ -0,0 +1,30 @@
+#!/bin/sh
+if [ -z "$husky_skip_init" ]; then
+  debug () {
+    [ "$HUSKY_DEBUG" = "1" ] && echo "husky (debug) - $1"
+  }
+
+  readonly hook_name="$(basename "$0")"
+  debug "starting $hook_name..."
+
+  if [ "$HUSKY" = "0" ]; then
+    debug "HUSKY env variable is set to 0, skipping hook"
+    exit 0
+  fi
+
+  if [ -f ~/.huskyrc ]; then
+    debug "sourcing ~/.huskyrc"
+    . ~/.huskyrc
+  fi
+
+  export readonly husky_skip_init=1
+  sh -e "$0" "$@"
+  exitCode="$?"
+
+  if [ $exitCode != 0 ]; then
+    echo "husky - $hook_name hook exited with code $exitCode (error)"
+    exit $exitCode
+  fi
+
+  exit 0
+fi

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx lint-staged

.prettierignore

@@ -0,0 +1,6 @@
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader

.prettierrc.json

@@ -0,0 +1,4 @@
+{
+  "printWidth": 100,
+  "proseWrap": "always"
+}

README.md

@@ -0,0 +1,69 @@
+# Bitwarden Contributing Docs
+
+The current version of the docs are accessible at:
+
+- https://contributing.bitwarden.com/
+
+## Install
+
+```bash
+npm ci
+```
+
+## Local Development
+
+```bash
+npm start
+```
+
+This command starts a local development server and opens up a browser window. Most changes are
+reflected live without having to restart the server.
+
+## Build
+
+```bash
+npm build
+```
+
+This command generates static content into the `build` directory and can be served using any static
+contents hosting service.
+
+## Writing
+
+This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website
+generator.
+
+Documentation is located under `docs`.
+
+### Conditional Content
+
+The Contributing Docs site is used both for internal and external contributors. To this end we've
+facilitated a mean to conditionally show content for either group. This is primarily to keep the
+external docs simple.
+
+```md
+<community>
+
+This content is shown only to community contributors.
+
+</community>
+
+<bitwarden>
+
+This content is shown only to bitwarden contributors.
+
+</bitwarden>
+```
+
+The technical implementation uses a custom context called `devMode` which is persisted to local
+storage, and is exposed as a dropdown in the navigation bar.
+
+It's also possible to conditionally hide pages from the navigation using `frontMatter`. This is
+easiest done using the `access` property, which can be either `community` or `bitwarden`.
+
+```yml
+---
+sidebar_custom_props:
+  access: bitwarden
+---
+```

babel.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [require.resolve("@docusaurus/core/lib/babel/preset")],
+};

docs/architecture/adr/0001-reactive-forms.md

@@ -0,0 +1,46 @@
+---
+adr: "0001"
+status: In progress
+date: 2022-05-28
+tags: [clients, angular, forms]
+---
+
+# 0001 - Angular Reactive Forms
+
+<AdrTable frontMatter={frontMatter}></AdrTable>
+
+## Context and Problem Statement
+
+Most of the forms in our Angular applications use the template driven forms. Lately we have been
+noticing issues scaling and maintaining these forms. And have begun mixing the use of
+template-driven with reactive forms.
+
+Maintaining two ways of handling forms are complex and moving full into a single approach will
+ensure a more consistent experience for developers and users.
+
+## Considered Options
+
+- **Reactive forms** - Provide direct, explicit access to the underlying forms object model.
+  Compared to template-driven forms, they are more robust: they're more scalable, reusable, and
+  testable. If forms are a key part of your application, or you're already using reactive patterns
+  for building your application, use reactive forms.
+- **Template-driven forms** - Rely on directives in the template to create and manipulate the
+  underlying object model. They are useful for adding a simple form to an app, such as an email list
+  signup form. They're straightforward to add to an app, but they don't scale as well as reactive
+  forms. If you have very basic form requirements and logic that can be managed solely in the
+  template, template-driven forms could be a good fit.
+
+Source: https://angular.io/guide/forms-overview#choosing-an-approach
+
+## Decision Outcome
+
+Chosen option: **Reactive forms**, because our needs exceed what template-driven forms are
+recommended for.
+
+### Positive Consequences <!-- optional -->
+
+- You never need to think which form method to use.
+
+### Negative Consequences <!-- optional -->
+
+- Using only reactive form means we might have some additional boilerplate.

docs/architecture/adr/0002-public-module-npm-packages.md

@@ -0,0 +1,39 @@
+---
+adr: "0002"
+status: In progress
+date: 2022-06-02
+tags: [clients]
+---
+
+# 0002 - Public API for modules
+
+<AdrTable frontMatter={frontMatter}></AdrTable>
+
+## Context and Problem Statement
+
+We currently use direct file reference across different packages. This had led to everything in the
+packages being available to any other package across our projects. Which makes it difficult to
+identity what potential side effects a change might have as they are not isolated to the individual
+package. Traditionally only a specific subset of a package is exposed as a public module, which
+provides safety that changes will be internal to the package and ideally covered by it's unit tests.
+
+## Considered Options
+
+- **Direct references** - We can decide to continue as is. Without a public API.
+- **Define public modules using index.ts** - We add `index.ts` to each folder that defines the
+  "public" interfaces. The other packages then imports the root index file and are forbidden from
+  direct references to internal files.
+
+## Decision Outcome
+
+Chosen option: **Define a public module using index.ts**.
+
+### Positive Consequences <!-- optional -->
+
+- The public module is defined.
+- Imports can be kept cleaner since not every file needs to be manually imported.
+- Safety in knowing that a change is isolated to the package.
+
+### Negative Consequences <!-- optional -->
+
+- We will have to update `index.ts` files whenever we add a new exported API.