bitwarden/contributing-docs

Contributing documentation

---

Bitwarden Client Applications

This repository houses all Bitwarden client applications except the Mobile application.

Please refer to the Clients section of the Contributing Documentation for build instructions, recommended tooling, code style tips, and lots of other great information to get you started.

Related projects:

• bitwarden/server: The core infrastructure backend (API, database, Docker, etc).
• bitwarden/mobile: The mobile app vault (iOS and Android).
• bitwarden/directory-connector: A tool for syncing a directory (AD, LDAP, Azure, G Suite, Okta) to an organization.

We're Hiring!

Interested in contributing in a big way? Consider joining our team! We're hiring for many positions. Please take a look at our Careers page to see what opportunities are currently open as well as what it's like to work at Bitwarden.

Contribute

Code contributions are welcome! Please commit any pull requests against the main branch. Learn more about how to contribute by reading the Contributing Guidelines. Check out the Contributing Documentation for how to get started with your first contribution.

Security audits and feedback are welcome. Please open an issue or email us privately if the report is sensitive in nature. You can read our security policy in the SECURITY.md file.

contributing-docs's Issues

[Discussion] Regarding ADR-0009

Page

https://github.com/bitwarden/contributing-docs/blob/873d980e0caa21dd60db0ab467c5bf3fbb4f6e95/docs/architecture/adr/0009-angular-composition-over-inheritance.md

Regarding ADR-0009 I want to ensure I am clear about the process of creating a new component that has a view in each client.

I would first create a service that fully encapsulates all business logic like so:

interface IDoSomethingService {
  sayHello(name: string);
  getDataFromServer(): Observable<MyData>;
  cleanup();
}

Then I need to do the following for each client

// x3
@MyView("[client-name]-view.html")
class Component {
  textBox: HTMLElement;
  data: Observable<MyData>;

  constructor(private myService: IDoSomethingService) {}

  ngOnInit() => data = myService.getDataFromServer();

  submit() => myService.sayHello(textBox.value);

  ngOnDestroy() => myService.cleanup();
}

vs creating a base component that is nearly exactly the above component (minus the @MyView() and the implementation for each client would be like this:

// Browser
@MyView("browser-view.html")
class BrowserComponent implements Component {}

// Desktop
@MyView("desktop-view.html")
class DesktopComponent implements Component {}

// Web
@MyView("web-view.html")
class WebComponent implements Component {}

Is that a fair representation of what this ADR wants?

To anyone having `Cannot read properties of undefined (reading 'length')` warning

Page

http://localhost:3000/

Expected Result

Run npm start and open http://localhost:3000/ without warnings.

Actual Result

npm start script launches http://localhost:3000/ with a warning overlaying on top.

Screenshots or Videos

Additional Context

Upon cloning this project, installing the dependencies and launching the dev server I noticed the error above.

This is being caused by the docusaurus-lunr-search dependency and it currently has an open PR praveenn77/docusaurus-lunr-search#120 aiming to fix it.

Issue Tracking Info

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

SDK Kubernetes page contains links to a repo that no longer exists

Page

https://contributing.bitwarden.com/getting-started/sdk/secrets-manager/integrations/kubernetes

Expected Result

Redirect to sm-kubernetes repo

Actual Result

404 Page

Screenshots or Videos

No response

Additional Context

It looks like sm-kubernetes and sm-operator have been deprecated and replaced by Helm. If so, it seems like this page would need to be revised to reflect these changes.

Issue Tracking Info

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

Issue in Certificate Generation in MacOS

Page

https://contributing.bitwarden.com/getting-started/server/guide#macos

Expected Result

I tried following the instructions for certificate generation but MacOS kept saying I had an invalid password, even though I was sure I had entered it in correctly.

Actual Result

MacOS prompted me for the password again, saying the password was invalid and asked me to re-enter my password.

Screenshots or Videos

No response

Additional Context

Going to this StackOverflow answer, I found that I had to downgrade to version 1.1 of OpenSSL.

Not sure where this piece of information could be added in the documentation (if it needs to be added at all), but thought I'd let you guys know.

Issue Tracking Info

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

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• [deps]: Update @types/react to v18.2.79
• [deps]: Update docusaurus monorepo to v3.2.1 (@docusaurus/core, @docusaurus/module-type-aliases, @docusaurus/preset-classic, @docusaurus/tsconfig)
• [deps]: Update typescript to v5.4.5
• [deps]: Update cspell to v8.7.0
• [deps]: Lock file maintenance
• Click on this checkbox to rebase all open PRs at once

Detected dependencies

github-actions

.github/workflows/build.yml

• actions/checkout v4.1.1@b4ffde65f46336ab88eb53be808477a3936bae11
• actions/setup-node v4.0.2@60edb5dd545a775178f52524783378180af0d1f8
• ubuntu 22.04

.github/workflows/lint.yml

• actions/checkout v4.1.1@b4ffde65f46336ab88eb53be808477a3936bae11
• actions/setup-node v4.0.2@60edb5dd545a775178f52524783378180af0d1f8
• ubuntu 22.04

npm

package.json

• @docusaurus/core 3.2.0
• @docusaurus/preset-classic 3.2.0
• @mdx-js/react 3.0.1
• docusaurus-lunr-search 3.3.2
• prism-react-renderer 2.3.1
• react 18.2.0
• react-dom 18.2.0
• remark-kroki 0.3.5
• @docusaurus/module-type-aliases 3.2.0
• @docusaurus/tsconfig 3.2.0
• @types/react 18.2.73
• cspell 8.6.1
• husky 9.0.11
• lint-staged 15.2.2
• prettier 3.2.5
• typescript 5.4.3
• node >=18

---

• Check this box to trigger a request for Renovate to run again on this repository