diff --git a/contributing.md b/contributing.md index 5aae7819f..73a05ee72 100644 --- a/contributing.md +++ b/contributing.md @@ -1,33 +1,51 @@ -# Contributing to Boostnote +# Contributing to Boostnote (English) -## When you open an issue of a bug report +### When you open an issue of a bug report There are no issue template. But there is a request. **Please paste screenshots of Boostnote with developer tool open** Thank you for your help in advance. -## About copyright of Pull Request +### About copyright of Pull Request -If you make a pull request, It means you agree to transfer the copyright of the code changes to MAISIN&CO. +If you make a pull request, It means you agree to transfer the copyright of the code changes to Maisin&Co. It doesn't mean Boostnote will become a paid app. If we want to earn some money, We will try other way, which is some kind of cloud storage, Mobile app integration or some SPECIAL features. Because GPL v3 is too strict to be compatible with any other License, We thought this is needed to replace the license with much freer one(like BSD, MIT) somewhen. --- +# Contributing to Boostnote (Russian) + +### Когда у вас появляется сообщение об ошибке +У нас нет шаблона, по которому вы должны описать ошибку. Просто расскажите, как вы получили ее + +**Вставьте скриншот Boostnote с открытым инструментом разработчика (dev tools)** + +Благодарим Вас за помощь! + +### Об авторских правах Pull Request + +Если вы делаете pull request, значит вы согласны передать авторские права на изменения кода в Maisin&Co. + +Это не означает, что Boostnote станет платным приложением. Если мы захотим заработать немного денег, мы найдем другой способ. Например, использование облачного хранилища, интеграцией мобильных приложений или другими специальными функциями. +Так как лицензия GPL v3 слишком строгая, чтобы быть совместимой с любой другой лицензией, мы думаем, что нужно заменить лицензию на более свободную (например, BSD, MIT). + +--- + # Contributing to Boostnote (Korean) -## 버그 리포트를 보고할 때 +### 버그 리포트를 보고할 때 이슈의 양식은 없습니다. 하지만 부탁이 있습니다. **개발자 도구를 연 상태의 Boostnote 스크린샷을 첨부해주세요** 도움을 주셔서 감사합니다. -## Pull Request의 저작권에 관하여 +### Pull Request의 저작권에 관하여 -당신이 pull request를 요청하면, 코드 변경에 대한 저작권을 MAISIN&CO에 양도한다는 것에 동의한다는 의미입니다. +당신이 pull request를 요청하면, 코드 변경에 대한 저작권을 Maisin&Co에 양도한다는 것에 동의한다는 의미입니다. 이것은 Boostnote가 유료화가 되는 것을 의미하는 건 아닙니다. 만약 우리가 자금이 필요하다면, 우리는 클라우드 연동, 모바일 앱 통합 혹은 특수한 기능 같은 것을 사용해 수입 창출을 시도할 것입니다. GPL v3 라이센스는 다른 라이센스와 혼합해 사용하기엔 너무 엄격하므로, 우리는 BSD, MIT 라이센스와 같은 더 자유로운 라이센스로 교체하는 것을 생각하고 있습니다. @@ -36,16 +54,16 @@ GPL v3 라이센스는 다른 라이센스와 혼합해 사용하기엔 너무 # Contributing to Boostnote (Japanese) -## バグレポートに関してのissueを立てる時 +### バグレポートに関してのissueを立てる時 イシューテンプレートはありませんが、1つお願いがあります。 **開発者ツールを開いた状態のBoostnoteのスクリーンショットを貼ってください** よろしくお願いします。 -## Pull requestの著作権について +### Pull requestの著作権について -Pull requestをすることはその変化分のコードの著作権をMAISIN&CO.に譲渡することに同意することになります。 +Pull requestをすることはその変化分のコードの著作権をMaisin&Co.に譲渡することに同意することになります。 アプリケーションのLicenseをいつでも変える選択肢を残したいと思うからです。 これはいずれかBoostnoteが有料の商用アプリになる可能性がある話ではありません。 diff --git a/docs/ru/build.md b/docs/ru/build.md new file mode 100644 index 000000000..c29eaba0c --- /dev/null +++ b/docs/ru/build.md @@ -0,0 +1,57 @@ +# Сборка + +## Используемые инструменты +* npm: 4.x +* node: 7.x + +Вы должны использовать `npm v4.x`, так как `$ grand pre-build` не работает в `v5.x`. + +## Разработка + +Мы используем Webpack HMR при разработке Boostnote. +Выполнение следующих команд в корне проекта запустит Boostnote с настройками по умолчанию. + +Установите необходимые пакеты с помощью yarn. + +``` +$ yarn +``` + +Соберите и запустите. + +``` +$ yarn run dev-start +``` + +Эта команда выполняет `yarn run webpack` и `yarn run hot` параллельно. Результат будет такой же, если вы выполните эти две команды раздельно. + +`Webpack` будет следить за изменениями в коде и будет применять их автоматически. + +Если возникает следующая ошибка: `Failed to load resource: net::ERR_CONNECTION_REFUSED`, пожалуйста, перезапустите Boostnote. + +![net::ERR_CONNECTION_REFUSED](https://cloud.githubusercontent.com/assets/11307908/24343004/081e66ae-1279-11e7-8d9e-7f478043d835.png) + +> ### Примечание +> В некоторых случаях вам необходимо обновить приложение вручную. +> 1. При редактировании метода конструктора компонента +> 2. При добавлении нового класса CSS (аналогично 1: Класс CSS перезаписывается каждым компонентом. Этот процесс выполняется в методе Constructor.) + +## Деплой + +Мы используем Grunt для автоматического деплоя. +Вы можете создать задачу, используя `grunt`. Однако мы не рекомендуем этого делать, так как задача по умолчанию включает в себя код и аутентификацию. + +Мы подготовили отдельный скрипт, который просто создает исполняемый файл: + +``` +grunt pre-build +``` + +Вы найдете исполняемый файл в папке `dist`. Обратите внимание: автоматическое обновление не будет работать, потому что приложение не подписано. + +Если вам необходимо, вы можете использовать код или аутентификацию с помощью этого исполняемого файла. + +--- + +Special thanks: +Translated by @AlexanderBelkevich diff --git a/docs/ru/debug.md b/docs/ru/debug.md new file mode 100644 index 000000000..0a9b8a388 --- /dev/null +++ b/docs/ru/debug.md @@ -0,0 +1,25 @@ +# Как отладить Boostnote (приложение Electron) +Boostnote - это программа, сделанная с помощью Electron, поэтому она базируется на Chromium. Разработчики могут использовать `Developer Tools` в Google Chrome для отладки. + +Вы можете переключиться в `Developer Tools` следующим образом: +![how_to_toggle_devTools](https://cloud.githubusercontent.com/assets/11307908/24343585/162187e2-127c-11e7-9c01-23578db03ecf.png) + +`Developer Tools` будет выглядеть следующим образом: +![Developer_Tools](https://cloud.githubusercontent.com/assets/11307908/24343545/eff9f3a6-127b-11e7-94cf-cb67bfda634a.png) + +Возможные ошибки отображаются во вкладке `console`. + +## Отладка +Например, вы можете использовать `debugger`, чтобы установить точку остановы следующим образом: + +![debugger](https://cloud.githubusercontent.com/assets/11307908/24343879/9459efea-127d-11e7-9943-f60bf7f66d4a.png) + +Это всего лишь пример. Вы можете использовать любой свой способ отладки. Тот, который вам будет удобен. + +## Рекомендации +* [Официальная документация Google Chrome об отладке](https://developer.chrome.com/devtools) + +--- + +Special thanks: +Translated by @AlexanderBelkevich diff --git a/docs/ru/testing.md b/docs/ru/testing.md new file mode 100644 index 000000000..58d39f34f --- /dev/null +++ b/docs/ru/testing.md @@ -0,0 +1,20 @@ +# Тестирование для Boostnote +## Тестирование e2e +Существуют тесты e2e для Boostnote, написанные на [ava](https://github.com/avajs/ava) и [spectron](https://github.com/electron/spectron). + +### Как запустить +Для тестирование e2e существует команда: + +``` +$ yarn run test:e2e +``` + +Причина, по которой я использую другую команду тестирования - это удобство travisCI. + +### TravisCI +Я установил тесты e2e, запущенные на travisCI, только в ветке master. Если вас это интересует, ознакомьтесь с файлом .travis.yml + +--- + +Special thanks: +Translated by @AlexanderBelkevich