Add contributing info to README

- Close #357
This commit is contained in:
Michael Rose 2016-06-12 22:26:18 -04:00
parent bf0e0df084
commit 26f92debe1

View file

@ -47,15 +47,29 @@ For even more demo pages check the [posts archive][year-archive].
---
### Credits
## Contributing
#### Icons + Demo Images:
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
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.
---
## Credits
### Icons + Demo Images:
- [The Noun Project](https://thenounproject.com) -- Garrett Knoll, Arthur Shlain, and [tracy tam](https://thenounproject.com/tracytam)
- [Font Awesome](http://fortawesome.github.io/Font-Awesome/)
- [Unsplash](https://unsplash.com/)
#### Other:
### Other:
- [Jekyll](http://jekyllrb.com/)
- [jQuery](http://jquery.com/)
@ -69,6 +83,8 @@ For even more demo pages check the [posts archive][year-archive].
---
## License
The MIT License (MIT)
Copyright (c) 2016 Michael Rose