mirror of
https://github.com/bitwarden/browser.git
synced 2024-11-23 11:56:00 +01:00
94aece134c
* expand contributing guide * fix typo
42 lines
2.5 KiB
Markdown
42 lines
2.5 KiB
Markdown
# How to Contribute
|
|
|
|
Contributions of all kinds are welcome!
|
|
|
|
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 [User-to-User Support category](https://community.bitwarden.com/c/support/) on the Community Forums
|
|
|
|
* **Translate:** See the localization (l10n) section below
|
|
|
|
## Contributor Agreement
|
|
|
|
Please sign the [Contributor Agreement](https://cla-assistant.io/bitwarden/web) 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)
|
|
|
|
[![Crowdin](https://d322cqt584bo4o.cloudfront.net/bitwarden-web/localized.svg)](https://crowdin.com/project/bitwarden-web)
|
|
|
|
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 web vault into another language (or make a translation correction), please register an account at Crowdin and join our project here: https://crowdin.com/project/bitwarden-web
|
|
|
|
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/kspearrin).
|
|
|
|
You can read Crowdin's getting started guide for translators here: https://support.crowdin.com/crowdin-intro/
|