Skip to content
This repository was archived by the owner on Sep 12, 2023. It is now read-only.

style: bringing project to order #223

Open
wants to merge 13 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
105 changes: 53 additions & 52 deletions contributing.md
Original file line number Diff line number Diff line change
@@ -1,76 +1,77 @@
# Внеси свой вклад в развитие проекта!

Проект развивается на добровольной основе и в свободное время. Ты можешь поддержать его, следуя правилам, описанным ниже.
# Внеси свой вклад в развитие проекта

Проект развивается на добровольной основе и в свободное время. Ты можешь поддержать его, следуя правилам, описанным
ниже.

## Зачем заводить ишью

- Чтобы задать вопрос относительно проекта.
- Чтобы сообщить о баге.
- Чтобы обсудить идею пулл-реквеста.
- Чтобы избежать повторов и траты твоего времени, когда хочешь отправить пулл-реквест.

* Чтобы задать вопрос относительно проекта;
* Чтобы сообщить о баге;
* Чтобы обсудить идею пулл-реквеста;
* Чтобы избежать повторов и траты твоего времени, когда хочешь отправить пулл-реквест.

## Как заводить ишью


### Поиск

Прежде чем что-либо написать, следует сначала поискать в [ишью](https://github.com/CSSSR/csssr-project-template/issues), [пулл-реквестах](https://github.com/CSSSR/csssr-project-template/pulls) и [ридми](https://github.com/CSSSR/csssr-project-template#readme) интересующий вопрос. Возможно, это уже обсуждалось.
Если ты уверен, что твой вопрос раньше не встречался, то смело заводи [ишью](https://github.com/CSSSR/csssr-project-template/issues/new).

Прежде чем что-либо написать, следует сначала поискать в [ишью][REPO_ISSUES_LIST], [пулл-реквестах][REPO_PULLS_LIST] и
[ридми][REPO_README] интересующий вопрос. Возможно, это уже обсуждалось. Если ты уверен, что твой вопрос раньше не
встречался, то смело заводи [ишью][REPO_ISSUES_NEW].

### Вопрос

- Создай вопрос в [ишью](https://github.com/CSSSR/csssr-project-template/issues/new).
- Кратко опиши суть вопроса.
- **Вопрос должен касаться только этого проекта.** Не стоит злоупотреблять ишью ради своей выгоды.
Вопросы по вёрстке, программированию, какому-либо инструменту, библиотеке, фреймворку, плагину
и т.п. не рассматриваются - обращайся с ними в [stackoverflow.com](http://stackoverflow.com/),
[toster.ru](https://toster.ru/)
или воспользуйся поисковиками [Google](https://www.google.com/) и [Яндексом](https://www.yandex.ru/).
- Если вопрос решён, оставь об этом коммент и закрой ишью.


* Создай вопрос в [ишью][REPO_ISSUES_NEW];
* Кратко опиши суть вопроса;
* **Вопрос должен касаться только этого проекта.**
Не стоит злоупотреблять ишью ради своей выгоды. Вопросы по вёрстке, программированию, какому-либо инструменту,
библиотеке, фреймворку, плагину и т.п. не рассматриваются - обращайся с ними в
[stackoverflow.com][SITE_STACKOVERFLOW], [toster.ru][SITE_TOSTER] или воспользуйся поисковиками
[Google][SITE_GOOGLE] и [Яндексом][SITE_YANDEX];
* Если вопрос решён, оставь об этом коммент и закрой ишью.

### Репорт бага

- Если ты заметил баг, сообщи об этом в [ишью](https://github.com/CSSSR/csssr-project-template/issues/new).
- Кратко опиши, с чем он связан.
- Приложи лог или код с проблемой, предварительно оформив его в маркдауне.
- Ссылки на строки кода.
- Скрин при необходимости и только с конкретной областью, не нужно скринить весь рабочий стол.
- Если ты хочешь пофиксить или уже пофиксил этот баг, предложи пулл-реквест.

* Если ты заметил баг, сообщи об этом в [ишью][REPO_ISSUES_NEW];
* Кратко опиши, с чем он связан;
* Приложи лог или код с проблемой, предварительно оформив его в маркдауне;
* Ссылки на строки кода;
* Скрин при необходимости и только с конкретной областью, не нужно скринить весь рабочий стол;
* Если ты хочешь пофиксить или уже пофиксил этот баг, предложи пулл-реквест.

### Обсуждение идеи пулл-реквеста

- Создай [ишью](https://github.com/CSSSR/csssr-project-template/issues/new).
- Кратко опиши, что ты хочешь предложить.
- Приложи код, предварительно оформив его в маркдауне.
- Ссылки на строки кода.
- Скрин при необходимости и только с конкретной областью, не нужно скринить весь рабочий стол.
- Если ты хочешь сделать пулл-реквест, напиши об этом.
- Если уже есть реализация в форке этого репозитория, предложи аппрувнуть пулл-реквест.

* Создай [ишью][REPO_ISSUES_NEW];
* Кратко опиши, что ты хочешь предложить;
* Приложи код, предварительно оформив его в маркдауне;
* Ссылки на строки кода;
* Скрин при необходимости и только с конкретной областью, не нужно скринить весь рабочий стол;
* Если ты хочешь сделать пулл-реквест, напиши об этом;
* Если уже есть реализация в форке этого репозитория, предложи аппрувнуть пулл-реквест.

## Как заводить пулл-реквесты

- В комментарии укажи ссылку на обсуждение этого пулл-реквеста, чтобы не дублировать.
- Чтобы коммиты были понятными и в едином стиле, следует придерживаться
[соглашения по именованию коммитов](https://github.com/CSSSR/sputnik/blob/master/Git.md#5-Соглашение-по-именованию-коммитов).
- Соблюдай код-стайл от ESLint (TODO: добавить ишью для добавления проверки код-стайла тасков).

* В комментарии укажи ссылку на обсуждение этого пулл-реквеста, чтобы не дублировать;
* Чтобы коммиты были понятными и в едином стиле, следует придерживаться соглашения по именованию коммитов;
* Соблюдай код-стайл от ESLint (_TODO: добавить ишью для добавления проверки код-стайла тасков_).

## Помогай с ответами на вопросы

Знаешь ответ вопрос? Отвечая на него, ты сэкономишь нам время и тем самым внесёшь свой вклад.

Не секрет, что вокруг этого проекта уже образовалось своё микросообщество, за что мы им благодарны :)


## Как ещё можно помочь проекту?

- [Ставь звезду](https://github.com/CSSSR/csssr-project-template/stargazers).
- Делись [ссылкой на наш репозиторий](https://github.com/CSSSR/csssr-project-template) в соцсетях, форумах и любых других сообществах.
- И просто рассказывай о нас :)
Знаешь ответ вопрос? Отвечая на него, ты сэкономишь нам время и тем самым внесёшь свой вклад. Не секрет, что вокруг
этого проекта уже образовалось своё микросообщество, за что мы им благодарны :)

## Как ещё можно помочь проекту

* [Ставь звезду][REPO_STARGAZERS].
* Делись [ссылкой на наш репозиторий][REPO] в соцсетях, форумах и любых других сообществах.
* И просто рассказывай о нас :)

[REPO]: https://github.com/CSSSR/csssr-project-template
[REPO_ISSUES_LIST]: https://github.com/CSSSR/csssr-project-template/issues
[REPO_ISSUES_NEW]: https://github.com/CSSSR/csssr-project-template/issues/new
[REPO_PULLS_LIST]: https://github.com/CSSSR/csssr-project-template/pulls
[REPO_README]: https://github.com/CSSSR/csssr-project-template#readme
[REPO_STARGAZERS]: https://github.com/CSSSR/csssr-project-template/stargazers
[SITE_GOOGLE]: https://www.google.com/
[SITE_STACKOVERFLOW]: http://stackoverflow.com/
[SITE_TOSTER]: https://toster.ru/
[SITE_YANDEX]: https://www.yandex.ru/
79 changes: 47 additions & 32 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
{
"name": "csssr-project-template",
"version": "0.26.2",
"description": "A template for a quick start.",
"description": "A template for a quick start",
"keywords": [
"csssr-project-template",
"cpt",
Expand All @@ -16,44 +15,56 @@
"jade",
"stylus"
],
"scripts": {
"start": "gulp --debug",
"build": "gulp build",
"production": "cross-env NODE_ENV=production npm-run-all clean build",
"make-block": "babel-node make-block.js",
"lint:scripts": "eslint app gulp",
"lint:styles": "gulp styles:lint",
"lint:templates": "gulp templates:lint",
"lint": "npm-run-all -p lint:*",
"predeploy": "npm run production",
"deploy": "gulp deploy",
"clean": "rimraf dist app/styles/sprites/*.styl",
"prezip": "npm run production",
"zip": "gulp zip",
"patch": "gulp patch",
"minor": "gulp minor",
"major": "gulp major",
"prepush": "npm run lint"
},
"repository": {
"type": "git",
"url": "[email protected]:CSSSR/csssr-project-template.git"
"version": "0.26.2",
"engines": {
"node": ">=4.0.0",
"npm": ">=2.0.0"
},
"author": "Felix Exter <[email protected]> (https://github.com/felixexter)",
"contributors": [
"Aleksandr Petrov <[email protected]> (https://github.com/dzhiriki)",
"Maxim Samoilov <[email protected]> (https://github.com/nitive)"
],
"repository": "[email protected]:CSSSR/csssr-project-template.git",
"bugs": {
"url": "https://github.com/CSSSR/csssr-project-template/issues/",
"email": "[email protected]"
},
"homepage": "https://github.com/CSSSR/csssr-project-template/",
"engines": {
"node": ">=4.0.0",
"npm": ">=2.0.0"
"author": "Felix Exter <[email protected]> (https://github.com/felixexter)",
"contributors": [
"Aleksandr Petrov <[email protected]> (https://github.com/dzhiriki)",
"Maxim Samoilov <[email protected]> (https://github.com/nitive)",
"Denis Novikov <[email protected]> (https://github.com/denisnovikov)"
],
"config": {
"commitizen": {
"path": "cz-conventional-changelog"
},
"validate-commit-msg": {
"maxSubjectLength": 72,
"types": "conventional-commit-types"
}
},
"license": "MIT",
"private": true,
"scripts": {
"build": "gulp build",
"clean": "rimraf dist app/styles/sprites/*.styl",
"commit": "git-cz",
"commitmsg": "validate-commit-msg",
"predeploy": "npm run production",
"deploy": "gulp deploy",
"lint": "npm-run-all -p lint:*",
"lint:scripts": "eslint app gulp",
"lint:styles": "gulp styles:lint",
"lint:templates": "gulp templates:lint",
"major": "gulp major",
"make-block": "babel-node make-block.js",
"minor": "gulp minor",
"patch": "gulp patch",
"prepush": "npm run lint",
"production": "cross-env NODE_ENV=production npm-run-all clean build",
"release": "standard-version",
"start": "gulp --debug",
"prezip": "npm run production",
"zip": "gulp zip"
},
"devDependencies": {
"autoprefixer-stylus": "^0.9.0",
"babel": "^6.5.0",
Expand All @@ -67,7 +78,9 @@
"babel-runtime": "^6.22.0",
"bemto.jade": "^1.0.0",
"browser-sync": "^2.10.0",
"commitizen": "^2.9.6",
"cross-env": "^1.0.7",
"cz-conventional-changelog": "^2.0.0",
"debuga": "^1.0.2",
"eslint": "^2.12.0",
"eslint-loader": "^1.1.1",
Expand Down Expand Up @@ -113,12 +126,14 @@
"source-map-loader": "^0.1.5",
"spritesmith-dir-checker": "^1.0.0",
"spritesmith-stylus-retina-template": "^1.0.0",
"standard-version": "^4.2.0",
"stylint": "^1.3.6",
"stylint-stylish": "^1.2.0",
"stylus": "^0.54.5",
"stylus-import-if-exist": "^1.1.0",
"stylus-svg-size-template": "^1.0.0",
"svg4everybody": "^2.0.0",
"validate-commit-msg": "^2.14.0",
"webpack": "^1.12.9",
"webpack-stats-logger": "^1.0.1",
"webpack-stream": "^3.1.0"
Expand Down
Loading