2016-06-21 20:50:13 +02:00
|
|
|
# Contributing
|
|
|
|
|
|
2018-09-29 02:45:34 +02: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.
|
2016-06-21 20:50:13 +02:00
|
|
|
|
2018-09-29 02:45:34 +02:00
|
|
|
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.
|
2016-06-21 20:50:13 +02:00
|
|
|
|
2018-09-29 02:45:34 +02:00
|
|
|
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:.
|
2016-06-21 20:50:13 +02:00
|
|
|
|
|
|
|
|
## Pull Requests
|
|
|
|
|
|
2017-03-22 14:51:20 +01:00
|
|
|
When submitting a pull request:
|
|
|
|
|
|
|
|
|
|
1. Clone the repo.
|
2018-09-29 02:45:34 +02:00
|
|
|
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.
|
