2015-11-21 08:59:28 +01:00
|
|
|
# Contributing to KeeWeb
|
|
|
|
|
|
2015-11-21 09:04:44 +01:00
|
|
|
:+1: Thanks for taking the time to contribute! :gift:
|
2015-11-21 08:59:28 +01:00
|
|
|
|
|
|
|
|
## Issues
|
|
|
|
|
|
|
|
|
|
If you have found an bug, please [open an issue](https://github.com/antelle/keeweb/issues/new) and fill in the app version and your user-agent
|
2015-11-22 14:55:31 +01:00
|
|
|
(you can find these details in Settings/Help section). Please check [FAQ](https://github.com/antelle/keeweb/wiki/FAQ) before submitting a new issue
|
2015-11-25 16:33:32 +01:00
|
|
|
and [TODO](https://github.com/antelle/keeweb/wiki/TODO) before creating a feature request.
|
2015-11-21 08:59:28 +01:00
|
|
|
|
2015-11-21 09:00:56 +01:00
|
|
|
Please, describe the issue in details: what were your actions? What has happened?
|
2015-12-13 23:14:13 +01:00
|
|
|
Does it happen on Demo or New database? If no, how to reproduce this? If you are using a test db without your personal data, please attach it.
|
|
|
|
|
If it's possible, please, open dev tools in your browser and attach output log from it (Console tab). If you are using desktop app,
|
|
|
|
|
devtools can be opened from Settings/General/Advanced.
|
2015-11-21 08:59:28 +01:00
|
|
|
|
|
|
|
|
## Pull Requests
|
|
|
|
|
|
|
|
|
|
Plugins are not supported for now. So, if you want to add a feature, please, follow these steps:
|
|
|
|
|
|
2015-11-21 09:01:32 +01:00
|
|
|
1. make sure it's not listed in [banned features](https://github.com/antelle/keeweb/wiki/Unsupported-Features)
|
2015-11-25 16:33:32 +01:00
|
|
|
2. check compatibility with [the project roadmap](https://github.com/antelle/keeweb/wiki/TODO) and key features: you should not break anything
|
2015-11-21 08:59:28 +01:00
|
|
|
3. if your feature is introducing a lot of new UI, or is changing any UX or design concept, please, open an issue to discuss it first
|
2015-11-21 09:04:44 +01:00
|
|
|
4. please, respect existing style in code, styles and markup (hint: install and enable [editorconfig](http://editorconfig.org/) in your editor)
|
2015-11-21 08:59:28 +01:00
|
|
|
5. don't add any dependencies
|
|
|
|
|
6. test your code: it must work in browser, Windows, OSX and Linux
|
|
|
|
|
7. if your code is platform-dependent, please add corresponding switches
|
|
|
|
|
8. respect each platform: don't create behaviour which breaks interface guidelines or user expectations
|
|
|
|
|
9. run `grunt` and make sure it's passing
|
