steffen/website
1
0
Fork 0
Code Actions Packages Releases Activity

Update contributing info

Browse Source
This commit is contained in:
Michael Rose
2017-03-22 09:51:20 -04:00
parent 8d42316e70
commit ff0f63aaed
4 changed files with 18 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/_docs/19-contributing.md
View File

@ -2,7 +2,7 @@
title: "Contributing"
permalink: /docs/contributing/
excerpt: "How you can contribute to make this theme better."
modified: 2016-11-03T11:37:14-04:00
modified: 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.
@ -13,6 +13,10 @@ This goes for author sidebar links and "share button" additions -- I have no int
## Pull Requests
To help me out try to avoid creating pull requests on `master` and instead branch off of `develop`. It's much easier for me to test, merge, and roll them into new releases this way.
When submitting a pull request:
Theme documentation and demo pages can be found in the [`/docs`](https://github.com/{{ site.repository }}/blob/master/docs) if submitting improvements, typo corrections, etc.
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.