mirror of
https://github.com/codeninjasuk/codeninjasuk.github.io.git
synced 2024-12-01 11:36:51 -05:00
22 lines
1.5 KiB
Markdown
22 lines
1.5 KiB
Markdown
|
---
|
||
|
|
title: "Contributing"
|
||
|
|
permalink: /docs/contributing/
|
||
|
|
excerpt: "How you can contribute to make this theme better."
|
||
|
|
last_modified_at: 2017-03-22T09:51:05-04:00
|
||
|
|
---
|
||
|
|
|
||
|
|
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.
|
||
|
|
|
||
|
|
Theme documentation and demo pages can be found in the [`/docs`](https://github.com/{{ site.repository }}/blob/master/docs) folder if you'd like to tackle any "low-hanging fruit" like fixing typos, bad grammar, etc.
|