expand contributing guide (#200)
This commit is contained in:
parent
79b856cb6e
commit
40214e80a6
|
@ -1,4 +1,30 @@
|
||||||
Code contributions are welcome! Please commit any pull requests against the `master` branch.
|
# 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
|
||||||
|
|
||||||
|
## Contributor Agreement
|
||||||
|
|
||||||
|
Please sign the [Contributor Agreement](https://cla-assistant.io/bitwarden/jslib) 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
|
||||||
|
|
||||||
# Setting up your Local Dev environment for jslib
|
# Setting up your Local Dev environment for jslib
|
||||||
In order to easily test, check and develop against local changes to jslib across each of the TypeScript/JavaScript clients it is recommended to use symlinks for the submodule so that you only have to make the change once and don't need to x-copy or wait for a commit+merge to checkout, pull and test against your other repos.
|
In order to easily test, check and develop against local changes to jslib across each of the TypeScript/JavaScript clients it is recommended to use symlinks for the submodule so that you only have to make the change once and don't need to x-copy or wait for a commit+merge to checkout, pull and test against your other repos.
|
||||||
|
|
Loading…
Reference in New Issue