-
Notifications
You must be signed in to change notification settings - Fork 2
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
Showing
480 changed files
with
46,666 additions
and
203 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 @@ | ||
# Contributing | ||
|
||
Having trouble working with the theme? Found a typo in the documentation? | ||
Interested in adding a feature or [fixing a bug](https://github.com/mmistakes/minimal-mistakes/issues)? | ||
Then by all means [submit an issue](https://github.com/mmistakes/minimal-mistakes/issues/new) | ||
or [pull request](https://help.github.com/articles/using-pull-requests/). | ||
If this is your first pull request, it may be helpful to read up on the | ||
[GitHub Flow](https://guides.github.com/introduction/flow/) first. | ||
|
||
Minimal Mistakes has been designed as a base for you to customize and fit your | ||
site's unique needs. Please keep this in mind when requesting features and/or | ||
submitting pull requests. If it's not something that most people will use, I | ||
probably won't consider it. When in doubt ask. | ||
|
||
This goes for author sidebar links and "share button" additions -- I have no | ||
intention of merging in every possibly option, the essentials are there to get | ||
you started :smile:. | ||
|
||
## Pull Requests | ||
|
||
When submitting a pull request: | ||
|
||
1. Clone the repo. | ||
2. Create a branch off of `master` and give it a meaningful name (e.g. | ||
`my-awesome-new-feature`) and describe the feature or fix. | ||
3. Open a pull request on GitHub. |
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,68 @@ | ||
--- | ||
name: "Bug Report" | ||
about: "Is something not working as expected?" | ||
--- | ||
|
||
<!-- | ||
Before opening a new issue please: | ||
- Verify you have the latest versions of Jekyll and Minimal Mistakes | ||
installed by running `bundle update`. | ||
- Thoroughly read the theme's documentation at | ||
https://mmistakes.github.io/minimal-mistakes/docs/quick-start-guide/ | ||
- Search all issues at https://github.com/mmistakes/minimal-mistakes/issues | ||
for solutions and to avoid duplication. | ||
- Ask for help at http://talk.jekyllrb.com/ | ||
After exhausting these suggestions use the format below. | ||
--> | ||
|
||
## Environment | ||
|
||
<!-- | ||
Please include theme version, Jekyll version, public git repository, whether | ||
you are hosting with GitHub Pages, and the operating system you tested with. | ||
Issues without a link to a public repository or ZIP file will likely go ignored. | ||
Being able to see your actual files is necessary to troubleshoot, as most | ||
issues stem from invalid/missing YAML Front Matter, a mis-configured _config.sys | ||
file, or problematic site content. | ||
--> | ||
|
||
- Minimal Mistakes version: | ||
- Ruby gem or remote theme version: | ||
- Jekyll version: | ||
- Git repository URL: | ||
- GitHub Pages hosted (if yes provide URL to site): | ||
- Operating system: | ||
|
||
## Expected behavior | ||
|
||
<!-- | ||
What is it you expected to happen? This should be a description of how the | ||
functionality you tried to use is supposed to work. | ||
--> | ||
|
||
## Steps to reproduce the behavior | ||
|
||
<!-- | ||
Describe the steps you took for this problem to exist. Such as: you installed | ||
the theme, customized _config.yml, added your own posts, and started up a | ||
Jekyll server locally. | ||
If an error occurred on GitHub Pages when pushing, please test a local version | ||
following these setup instructions: | ||
https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/ | ||
Then provide a complete log by running `bundle exec jekyll build --trace --verbose` | ||
and include this output in the filed issue. | ||
Screenshots can also be included if they help illustrate a behavior. | ||
--> | ||
|
||
## Other | ||
|
||
<!-- | ||
NOTE: Please provide a code repository, gist, code snippet, sample files, | ||
screenshots, or anything else you think will aid in reproducing the issue. | ||
--> |
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,16 @@ | ||
--- | ||
name: "Documentation" | ||
about: "Found a typo or something that needs clarification?" | ||
--- | ||
|
||
<!-- Thanks for taking the time to open an issue and help make the docs better --> | ||
|
||
## Motivation | ||
|
||
<!-- Why should we update our docs? --> | ||
|
||
<!-- What should we do instead? --> | ||
|
||
## Suggestion | ||
|
||
<!-- What should we do instead? --> |
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,32 @@ | ||
--- | ||
name: "Enhancement / Feature Request" | ||
about: "What would make this theme better?" | ||
--- | ||
|
||
<!-- | ||
Before opening a new issue please search all issues at | ||
https://github.com/mmistakes/minimal-mistakes/issues to avoid duplication. | ||
--> | ||
|
||
## Summary | ||
|
||
<!-- | ||
A short explanation of the enhancement or feature. | ||
--> | ||
|
||
## Motivation | ||
|
||
<!-- | ||
Why do you want to see this feature in the theme? | ||
What use cases does it support? | ||
NOTE: This theme has been designed as a base for you to customize and fit | ||
your site's unique needs. If a feature is not something most people will use, | ||
it likely won't be considered. When in doubt ask. | ||
--> | ||
|
||
## Drawbacks | ||
|
||
<!-- | ||
Why should this enhancement or feature **not** be considered? | ||
--> |
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,22 @@ | ||
--- | ||
name: "Question" | ||
about: "Having trouble working with the theme?" | ||
--- | ||
|
||
<!-- | ||
Before opening a new issue please: | ||
- Verify you have the latest versions of Jekyll and Minimal Mistakes | ||
installed by running `bundle update`. | ||
- Thoroughly read the theme's documentation at | ||
https://mmistakes.github.io/minimal-mistakes/docs/quick-start-guide/ | ||
- Search all issues at https://github.com/mmistakes/minimal-mistakes/issues | ||
for solutions and to avoid duplication. | ||
- Ask for help at http://talk.jekyllrb.com/ | ||
After exhausting these suggestions ask your question below. | ||
NOTE: Please provide a code repository, gist, code snippet, sample files, or | ||
screenshots to triage your issue. | ||
--> | ||
|
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 @@ | ||
<!-- | ||
Thanks for creating a Pull Request! Before you submit, please make sure | ||
you've done the following: | ||
- Read the contributing document at https://github.com/mmistakes/minimal-mistakes#contributing | ||
--> | ||
|
||
<!-- | ||
Choose one of the following by uncommenting it: | ||
--> | ||
|
||
<!-- This is a bug fix. --> | ||
<!-- This is an enhancement or feature. --> | ||
<!-- This is a documentation change. --> | ||
|
||
## Summary | ||
|
||
<!-- | ||
Provide a description of what your pull request changes. | ||
--> | ||
|
||
## Context | ||
|
||
<!-- | ||
Is this related to any GitHub issue(s)? | ||
--> |
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,20 @@ | ||
*.gem | ||
*.sublime-project | ||
*.sublime-workspace | ||
.bundle | ||
.DS_Store | ||
.jekyll-metadata | ||
.sass-cache | ||
_asset_bundler_cache | ||
_site | ||
codekit-config.json | ||
example/_site | ||
Gemfile.lock | ||
node_modules | ||
npm-debug.log* | ||
/.idea/checkstyle-idea.xml | ||
/.idea/misc.xml | ||
/.idea/modules.xml | ||
/.idea/vcs.xml | ||
/.idea/workspace.xml | ||
/ipf-docs.iml |
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,11 @@ | ||
language: ruby | ||
cache: bundler | ||
gemfile: docs/Gemfile | ||
script: | ||
- bundle exec jekyll algolia --source docs --destination docs/_site --config docs/_config.yml | ||
branches: | ||
only: | ||
# Change this to gh-pages if you're deploying using the gh-pages branch | ||
- master | ||
rvm: | ||
- 2.4 |
Oops, something went wrong.