-
-
Notifications
You must be signed in to change notification settings - Fork 210
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
3c95571
commit b88ab84
Showing
408 changed files
with
7,643 additions
and
2,991 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
{ | ||
"extends": "stylelint-config-sass-guidelines", | ||
"rules": { | ||
"block-opening-brace-space-before": null, | ||
"selector-class-pattern": null, | ||
"number-leading-zero": null, | ||
"indentation": null, | ||
"no-empty-source": null, | ||
"declaration-block-trailing-semicolon": null, | ||
"color-hex-case": null, | ||
"selector-list-comma-newline-after": null, | ||
"selector-max-compound-selectors": 4, | ||
"max-nesting-depth": 4, | ||
"value-no-vendor-prefix": null, | ||
"string-quotes": null, | ||
"color-named": null, | ||
"rule-empty-line-before": ["always", { | ||
"ignore": ["after-comment", "first-nested", "inside-block"] | ||
}], | ||
"selector-no-qualifying-type": [true, { | ||
"ignore": ["attribute", "class", "id"] | ||
}], | ||
"property-no-vendor-prefix": null, | ||
"order/properties-alphabetical-order": null | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,93 @@ | ||
# Contributing | ||
|
||
:smile: Thank you for contributing to Mapache! | ||
|
||
## Development | ||
|
||
Mpache uses [Gulp](https://gulpjs.com/) as a build tool and [Yarn](https://yarnpkg.com/) to manage front-end packages. | ||
|
||
```bash | ||
# clone this repo | ||
$ git clone https://github.com/godofredoninja/Mapache.git | ||
|
||
# Go to the folder | ||
$ cd Mapache | ||
|
||
# link to ghost themes dir | ||
$ ln -s $PWD path/to/ghost/content/themes/Mapache | ||
|
||
# install the dependencies | ||
$ yarn install | ||
|
||
# run build & livereload task | ||
$ yarn dev | ||
|
||
# restart ghost server | ||
$ cd path/to/ghost && ghost restart --development | ||
``` | ||
|
||
### Icons | ||
|
||
[Ionicons](https://github.com/ionic-team/ionicons) and generated by [Icomoon](https://icomoon.io/app/#/select) after import `src/svg-icons/selection.json` | ||
|
||
### Build commands | ||
|
||
- `yarn dev` — Compile assets when file changes are made, start [livereload](http://livereload.com/) | ||
- `yarn build` — Compile and optimize the files in your assets directory | ||
- `yarn prod` — Compile assets for production and generate a `dist/mapache.zip` | ||
|
||
### Additional commands | ||
|
||
- `yarn lint:js` — [Standard](https://standardjs.com/), Check for errors in the script. | ||
- `yarn lint:sass` — [Stylelint](https://stylelint.io/), Check for errors in the styles. | ||
- `yarn lint` — Check error in script and styles. | ||
- `yarn scan` — [Ghost Scan](https://github.com/TryGhost/gscan) check for errors, deprecation and other compatibility issues. | ||
- `yarn test` — Check the script errors and styles then check the theme if it is compatible with the latest version of Ghost. | ||
|
||
## Git/GitHub workflow | ||
|
||
This is our preferred process for opening a PR on GitHub: | ||
|
||
1. [Fork](http://help.github.com/fork-a-repo/) the repo, clone your fork, and configure the remotes: | ||
|
||
```bash | ||
# Clone your fork | ||
git clone https://github.com/<your-username>/Mapache.git | ||
|
||
# Navigate to the newly cloned directory | ||
cd Mapache | ||
|
||
# Assign the original repo to a remote called "upstream" | ||
git remote add upstream https://github.com/godofredoninja/Mapache.git | ||
``` | ||
|
||
2. If you cloned a while ago, get the latest changes from upstream: | ||
|
||
```bash | ||
git checkout master | ||
git pull upstream master | ||
``` | ||
|
||
3. Create a new topic branch (off the main project development branch) to contain your feature, change, or fix: | ||
|
||
```bash | ||
git checkout -b <topic-branch-name> | ||
``` | ||
|
||
4. Locally merge: | ||
|
||
```bash | ||
git checkout master | ||
git merge <topic-branch-name> | ||
``` | ||
|
||
5. When your changes are ready for review, push your branch: | ||
|
||
```bash | ||
git push origin master | ||
``` | ||
|
||
6. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/) with a clear title and description. | ||
|
||
7. When the changes have been reviewed and approved, I will merge for you. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file was deleted.
Oops, something went wrong.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.