diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index b11f2a39..6341d982 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -8,4 +8,8 @@ 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. \ No newline at end of file +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. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index d56b1528..8942f584 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -6,10 +6,10 @@ --> - [ ] This is a question about using the theme. -- [ ] I believe this to be a bug with the theme --- not Jekyll, GitHub Pages or one of the bundled plugins. - [ ] This is a feature request. - [ ] I have updated all gems with `bundle update`. - [ ] I have tested locally with `bundle exec jekyll build`. +- [ ] I believe this to be a bug with the theme --- not Jekyll, GitHub Pages or one of the bundled plugins. --- diff --git a/README.md b/README.md index ee6ca9b6..9e18f872 100644 --- a/README.md +++ b/README.md @@ -90,7 +90,11 @@ 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: + +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`](docs) if submitting improvements, typo corrections, etc. diff --git a/docs/_docs/19-contributing.md b/docs/_docs/19-contributing.md index 37771fd4..a3689efd 100644 --- a/docs/_docs/19-contributing.md +++ b/docs/_docs/19-contributing.md @@ -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. \ No newline at end of file +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. \ No newline at end of file