Update README and CONTRIBUTING to point to contributing.bitwarden.com (#2771)
Co-authored-by: Oscar Hinton <Hinton@users.noreply.github.com>
This commit is contained in:
Thomas Rittson
GitHub
parent
84666a7a74
commit
3b857345bb
|
|
@ -1,38 +1,3 @@
|
||||||
# How to Contribute
|
# How to Contribute
|
||||||
|
|
||||||
Contributions of all kinds are welcome!
|
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.
|
||||||
|
|
||||||
Please visit our [Community Forums](https://community.bitwarden.com/) for general community discussion and the development roadmap.
|
|
||||||
|
|
||||||
Here is how you can get involved:
|
|
||||||
|
|
||||||
- **Request a new feature:** Go to the [Feature Requests category](https://community.bitwarden.com/c/feature-requests/) of the Community Forums. Please search existing feature requests before making a new one
|
|
||||||
- **Write code for a new feature:** Make a new post in the [Github Contributions category](https://community.bitwarden.com/c/github-contributions/) of the Community Forums. Include a description of your proposed contribution, screeshots, and links to any relevant feature requests. This helps get feedback from the community and Bitwarden team members before you start writing code
|
|
||||||
- **Report a bug or submit a bugfix:** Use Github issues and pull requests
|
|
||||||
- **Write documentation:** Submit a pull request to the [Bitwarden help repository](https://github.com/bitwarden/help)
|
|
||||||
- **Help other users:** Go to the [Ask the Bitwarden Community category](https://community.bitwarden.com/c/support/) on the Community Forums
|
|
||||||
- **Translate:** See the localization (i10n) section below
|
|
||||||
|
|
||||||
## Contributor Agreement
|
|
||||||
|
|
||||||
Please sign the [Contributor Agreement](https://cla-assistant.io/bitwarden/clients) if you intend on contributing to any Github repository. Pull requests cannot be accepted and merged unless the author has signed the Contributor Agreement.
|
|
||||||
|
|
||||||
## Pull Request Guidelines
|
|
||||||
|
|
||||||
- use `npm run lint` and fix any linting suggestions before submitting a pull request
|
|
||||||
- commit any pull requests against the `master` branch
|
|
||||||
- include a link to your Community Forums post
|
|
||||||
|
|
||||||
# Localization (l10n)
|
|
||||||
|
|
||||||
We use a translation tool called [Crowdin](https://crowdin.com) to help manage our localization efforts across many different languages.
|
|
||||||
|
|
||||||
If you are interested in helping translate the Bitwarden applications into another language (or make a translation correction), please register an account at Crowdin and join our projects here:
|
|
||||||
|
|
||||||
- https://crowdin.com/project/bitwarden-web
|
|
||||||
- https://crowdin.com/project/bitwarden-desktop
|
|
||||||
- https://crowdin.com/project/bitwarden-browser
|
|
||||||
|
|
||||||
If the language that you are interested in translating is not already listed, create a new account on Crowdin, join the project, and contact the project owner (https://crowdin.com/profile/dwbit).
|
|
||||||
|
|
||||||
You can read Crowdin's getting started guide for translators here: https://support.crowdin.com/crowdin-intro/
|
|
||||||
|
|
|
||||||
12
README.md
12
README.md
|
|
@ -19,7 +19,7 @@
|
||||||
|
|
||||||
This repository houses all Bitwarden client applications except the [Mobile application](https://github.com/bitwarden/mobile).
|
This repository houses all Bitwarden client applications except the [Mobile application](https://github.com/bitwarden/mobile).
|
||||||
|
|
||||||
Please check the readmes for each application under `apps` for instructions on how to build the different applications.
|
Please refer to the [Clients section](https://contributing.bitwarden.com/clients/) of the [Contributing Documentation](https://contributing.bitwarden.com/) for build instructions, recommended tooling, code style tips, and lots of other great information to get you started.
|
||||||
|
|
||||||
## Related projects:
|
## Related projects:
|
||||||
|
|
||||||
|
|
@ -33,18 +33,10 @@ Interested in contributing in a big way? Consider joining our team! We're hiring
|
||||||
|
|
||||||
# Contribute
|
# Contribute
|
||||||
|
|
||||||
Code contributions are welcome! Please commit any pull requests against the `master` branch. Learn more about how to contribute by reading the [`CONTRIBUTING.md`](CONTRIBUTING.md) file.
|
Code contributions are welcome! Please commit any pull requests against the `master` branch. Learn more about how to contribute by reading the [Contributing Guidelines](https://contributing.bitwarden.com/contributing/). Check out the [Contributing Documentation](https://contributing.bitwarden.com/) 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`](SECURITY.md) file.
|
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`](SECURITY.md) file.
|
||||||
|
|
||||||
## Git blame
|
|
||||||
|
|
||||||
We recommend that you configure git to ignore specific revision using:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
git config blame.ignoreRevsFile .git-blame-ignore-revs
|
|
||||||
```
|
|
||||||
|
|
||||||
## Migrate PRs from old repositories
|
## Migrate PRs from old repositories
|
||||||
|
|
||||||
We recently migrated from individual client repositories. And some PRs were unfortunately left behind in the old repositories. Luckily it's fairly straightforward to sync them up again. Please follow all the instructions below in order to avoid most merge conflicts.
|
We recently migrated from individual client repositories. And some PRs were unfortunately left behind in the old repositories. Luckily it's fairly straightforward to sync them up again. Please follow all the instructions below in order to avoid most merge conflicts.
|
||||||
|
|
|
||||||
|
|
@ -17,36 +17,6 @@ The Bitwarden browser extension is written using the Web Extension API and Angul
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# Build/Run
|
## Documentation
|
||||||
|
|
||||||
**Requirements**
|
Please refer to the [Browser section](https://contributing.bitwarden.com/clients/browser/) of the [Contributing Documentation](https://contributing.bitwarden.com/) for build instructions, recommended tooling, code style tips, and lots of other great information to get you started.
|
||||||
|
|
||||||
- [Node.js](https://nodejs.org) v16.13.1 or greater
|
|
||||||
- NPM v8
|
|
||||||
- [Gulp](https://gulpjs.com/) (`npm install --global gulp-cli`)
|
|
||||||
- Chrome (preferred), Opera, or Firefox browser
|
|
||||||
|
|
||||||
**Run the app**
|
|
||||||
|
|
||||||
```
|
|
||||||
npm install
|
|
||||||
npm run build:watch
|
|
||||||
```
|
|
||||||
|
|
||||||
You can now load the extension into your browser through the browser's extension tools page:
|
|
||||||
|
|
||||||
- Chrome/Opera:
|
|
||||||
1. Type `chrome://extensions` in your address bar to bring up the extensions page.
|
|
||||||
2. Enable developer mode (toggle switch)
|
|
||||||
3. Click the "Load unpacked extension" button, navigate to the `build` folder of your local extension instance, and click "Ok".
|
|
||||||
- Firefox
|
|
||||||
1. Type `about:debugging` in your address bar to bring up the add-ons page.
|
|
||||||
2. Click the `Load Temporary Add-on` button, navigate to the `build/manifest.json` file, and "Open".
|
|
||||||
|
|
||||||
**Desktop communication**
|
|
||||||
|
|
||||||
Native Messaging (communication between the desktop application and browser extension) works by having the browser start a lightweight proxy baked into our desktop application.
|
|
||||||
|
|
||||||
Out of the box, the desktop application can only communicate with the production browser extension. When you enable browser integration in the desktop application, the application generates manifests which contain the production IDs of the browser extensions. To enable communication between the desktop application and development versions of browser extensions, add the development IDs to the `allowed_extensions` section of the corresponding manifests.
|
|
||||||
|
|
||||||
Manifests are located in the `browser` subdirectory of the Bitwarden configuration directory. For instance, on Windows the manifests are located at `C:\Users\<user>\AppData\Roaming\Bitwarden\browsers` and on macOS these are in `Application Support` for various browsers ([for example](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Native_manifests#manifest_location)). Note that disabling the desktop integration will delete the manifests, and the files will need to be updated again.
|
|
||||||
|
|
|
||||||
|
|
@ -9,7 +9,13 @@ The Bitwarden CLI is a powerful, full-featured command-line interface (CLI) tool
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Download/Install
|
## Developer Documentation
|
||||||
|
|
||||||
|
Please refer to the [CLI section](https://contributing.bitwarden.com/clients/cli/) of the [Contributing Documentation](https://contributing.bitwarden.com/) for build instructions, recommended tooling, code style tips, and lots of other great information to get you started.
|
||||||
|
|
||||||
|
## User Documentation
|
||||||
|
|
||||||
|
### Download/Install
|
||||||
|
|
||||||
You can install the Bitwarden CLI multiple different ways:
|
You can install the Bitwarden CLI multiple different ways:
|
||||||
|
|
||||||
|
|
@ -40,7 +46,7 @@ We provide natively packaged versions of the CLI for each platform which have no
|
||||||
sudo snap install bw
|
sudo snap install bw
|
||||||
```
|
```
|
||||||
|
|
||||||
## Documentation
|
### Help Command
|
||||||
|
|
||||||
The Bitwarden CLI is self-documented with `--help` content and examples for every command. You should start exploring the CLI by using the global `--help` option:
|
The Bitwarden CLI is self-documented with `--help` content and examples for every command. You should start exploring the CLI by using the global `--help` option:
|
||||||
|
|
||||||
|
|
@ -57,28 +63,6 @@ bw list --help
|
||||||
bw create --help
|
bw create --help
|
||||||
```
|
```
|
||||||
|
|
||||||
**Detailed Documentation**
|
### Help Center
|
||||||
|
|
||||||
We provide detailed documentation and examples for using the CLI in our help center at https://help.bitwarden.com/article/cli/.
|
We provide detailed documentation and examples for using the CLI in our help center at https://help.bitwarden.com/article/cli/.
|
||||||
|
|
||||||
## Build/Run
|
|
||||||
|
|
||||||
**Requirements**
|
|
||||||
|
|
||||||
- [Node.js](https://nodejs.org) v16.13.1.
|
|
||||||
- Testing is done against Node 16, other versions may work, but are not guaranteed.
|
|
||||||
- NPM v8
|
|
||||||
|
|
||||||
**Run the app**
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm install
|
|
||||||
npm run sub:init # initialize the git submodule for jslib
|
|
||||||
npm run build:watch
|
|
||||||
```
|
|
||||||
|
|
||||||
You can then run commands from the `./build` folder:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
node ./build/bw.js login
|
|
||||||
```
|
|
||||||
|
|
|
||||||
|
|
@ -10,32 +10,6 @@ The Bitwarden desktop app is written using Electron and Angular. The application
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# Build/Run
|
## Documentation
|
||||||
|
|
||||||
## Requirements
|
Please refer to the [Desktop section](https://contributing.bitwarden.com/clients/desktop/) of the [Contributing Documentation](https://contributing.bitwarden.com/) for build instructions, recommended tooling, code style tips, and lots of other great information to get you started.
|
||||||
|
|
||||||
- [Node.js](https://nodejs.org) v16.13.1 (LTS) or greater
|
|
||||||
- NPM v8
|
|
||||||
- Windows:
|
|
||||||
- To compile the native node modules used in the app you will need the _Visual C++ toolset_, available through the standard Visual Studio installer. You will also need to install the _Microsoft Build Tools 2015_ and _Windows 10 SDK 17134_ as additional dependencies in the Visual Studio installer.
|
|
||||||
- Linux:
|
|
||||||
- The following packages `build-essential libsecret-1-dev libglib2.0-dev`
|
|
||||||
|
|
||||||
## Run the app
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm ci
|
|
||||||
npm run electron
|
|
||||||
```
|
|
||||||
|
|
||||||
### Debug Native Messaging
|
|
||||||
|
|
||||||
Native Messaging (communication with the browser extension) works by having the browser start a lightweight proxy application baked into our desktop binary. To setup an environment which allows
|
|
||||||
for easy debugging you will need to build the application for distribution, i.e. `npm run dist:<platform>`, start the dist version and enable desktop integration. This will write some manifests
|
|
||||||
to disk, Consult the [native manifests](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Native_manifests#Manifest_location) documentation for more details of the manifest
|
|
||||||
format, and the exact locations for the different platforms. _Note_ that disabling the desktop integration will delete the manifests, and the files will need to be updated again.
|
|
||||||
|
|
||||||
The generated manifests are pre-configured with the production ID for the browser extensions. In order to use them with the development builds, the browser extension ID of the development build
|
|
||||||
needs to be added to the `allowed_extensions` section of the manifest. These IDs are generated by the browser, and can be found in the extension settings within the browser.
|
|
||||||
|
|
||||||
It will then be possible to run the desktop application as usual using `npm run electron` and communicate with the browser.
|
|
||||||
|
|
|
||||||
|
|
@ -1,9 +1,3 @@
|
||||||
> **Repository Reorganization in Progress**
|
|
||||||
>
|
|
||||||
> We are currently migrating some projects over to a mono repository. For existing PR's we will be providing documentation on how to move/migrate them. To minimize the overhead we are actively reviewing open PRs. If possible please ensure any pending comments are resolved as soon as possible.
|
|
||||||
>
|
|
||||||
> New pull requests created during this transition period may not get addressed —if needed, please create a new PR after the reorganization is complete.
|
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<img src="https://raw.githubusercontent.com/bitwarden/brand/master/screenshots/web-vault-macbook.png" alt="" width="600" height="358" />
|
<img src="https://raw.githubusercontent.com/bitwarden/brand/master/screenshots/web-vault-macbook.png" alt="" width="600" height="358" />
|
||||||
</p>
|
</p>
|
||||||
|
|
@ -25,74 +19,6 @@
|
||||||
</a>
|
</a>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
## Build/Run
|
## Documentation
|
||||||
|
|
||||||
### Requirements
|
Please refer to the [Web vault section](https://contributing.bitwarden.com/clients/web-vault/) of the [Contributing Documentation](https://contributing.bitwarden.com/) for build instructions, recommended tooling, code style tips, and lots of other great information to get you started.
|
||||||
|
|
||||||
- [Node.js](https://nodejs.org) v16.13.1 or greater
|
|
||||||
- NPM v8
|
|
||||||
|
|
||||||
### Run the app
|
|
||||||
|
|
||||||
For local development, run the app with:
|
|
||||||
|
|
||||||
```
|
|
||||||
npm install
|
|
||||||
npm run build:oss:watch
|
|
||||||
```
|
|
||||||
|
|
||||||
You can now access the web vault in your browser at `https://localhost:8080`.
|
|
||||||
|
|
||||||
If you want to point the development web vault to the production APIs, you can run using:
|
|
||||||
|
|
||||||
```
|
|
||||||
npm install
|
|
||||||
ENV=cloud npm run build:oss:watch
|
|
||||||
```
|
|
||||||
|
|
||||||
You can also manually adjusting your API endpoint settings by adding `config/local.json` overriding any of the following values:
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"dev": {
|
|
||||||
"proxyApi": "http://your-api-url",
|
|
||||||
"proxyIdentity": "http://your-identity-url",
|
|
||||||
"proxyEvents": "http://your-events-url",
|
|
||||||
"proxyNotifications": "http://your-notifications-url",
|
|
||||||
"allowedHosts": ["hostnames-to-allow-in-webpack"]
|
|
||||||
},
|
|
||||||
"urls": {}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
Where the `urls` object is defined by the [Urls type in jslib](https://github.com/bitwarden/jslib/blob/master/common/src/abstractions/environment.service.ts).
|
|
||||||
|
|
||||||
## 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](https://bitwarden.com/careers/) 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 `master` branch. Learn more about how to contribute by reading the [`CONTRIBUTING.md`](CONTRIBUTING.md) file.
|
|
||||||
|
|
||||||
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`](SECURITY.md) file.
|
|
||||||
|
|
||||||
## Prettier
|
|
||||||
|
|
||||||
We recently migrated to using Prettier as code formatter. All previous branches will need to updated to avoid large merge conflicts using the following steps:
|
|
||||||
|
|
||||||
1. Check out your local Branch
|
|
||||||
2. Run `git merge 2b0a9d995e0147601ca8ae4778434a19354a60c2`
|
|
||||||
3. Resolve any merge conflicts, commit.
|
|
||||||
4. Run `npm run prettier`
|
|
||||||
5. Commit
|
|
||||||
6. Run `git merge -Xours 56477eb39cfd8a73c9920577d24d75fed36e2cf5`
|
|
||||||
7. Push
|
|
||||||
|
|
||||||
### Git blame
|
|
||||||
|
|
||||||
We also recommend that you configure git to ignore the prettier revision using:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
git config blame.ignoreRevsFile .git-blame-ignore-revs
|
|
||||||
```
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue