Add CONTRIBUTING.md
This commit is contained in:
parent
7192b31562
commit
0c74169b6e
2 changed files with 50 additions and 2 deletions
47
CONTRIBUTING.md
Normal file
47
CONTRIBUTING.md
Normal file
|
@ -0,0 +1,47 @@
|
||||||
|
# Contributing to Hugo ʕ•ᴥ•ʔ Bear Blog
|
||||||
|
|
||||||
|
Thank you for your interest in contributing to Hugo ʕ•ᴥ•ʔ Bear Blog! This Hugo theme aims to maintain the simplicity and elegance of the original [ʕ•ᴥ•ʔ Bear Blog Platform](https://bearblog.dev/) while enabling you to host your site completely independently. Before contributing, please take a moment to review these guidelines.
|
||||||
|
|
||||||
|
## 🤔 Have a Question?
|
||||||
|
|
||||||
|
If you have questions about using the theme or implementing specific features:
|
||||||
|
|
||||||
|
1. Check our [existing GitHub issues](https://github.com/your-username/hugo-bear/issues) - your question might already be answered
|
||||||
|
2. Consider posting on the [Hugo Discourse](https://discourse.gohugo.io/) - there's a larger community there that might help, and your question could benefit others
|
||||||
|
|
||||||
|
## 🐛 Found a Bug?
|
||||||
|
|
||||||
|
If you've discovered a bug:
|
||||||
|
|
||||||
|
1. First, search our [existing issues](https://github.com/your-username/hugo-bear/issues) to see if it's already reported
|
||||||
|
2. If not, create a new issue with:
|
||||||
|
- A clear description of the problem
|
||||||
|
- Steps to reproduce the issue
|
||||||
|
- Expected vs actual behavior
|
||||||
|
- Your Hugo version and configuration
|
||||||
|
- Any relevant error messages or screenshots
|
||||||
|
|
||||||
|
## ✨ Feature Requests
|
||||||
|
|
||||||
|
While we appreciate feature suggestions, please note that Hugo ʕ•ᴥ•ʔ Bear Blog intentionally maintains a minimal feature set, staying true to the original [ʕ•ᴥ•ʔ Bear Blog Platform's](https://bearblog.dev/) philosophy.
|
||||||
|
|
||||||
|
Before submitting a feature request:
|
||||||
|
|
||||||
|
1. Review existing issues and discussions - your idea might have been discussed before
|
||||||
|
2. Consider if the feature could be implemented using Hugo's built-in capabilities
|
||||||
|
|
||||||
|
If you decide to submit a feature request, please:
|
||||||
|
- Clearly describe the feature and its use case
|
||||||
|
- Consider providing examples of similar implementations
|
||||||
|
|
||||||
|
## 🚀 Pull Requests
|
||||||
|
|
||||||
|
Pull requests are welcome! Please:
|
||||||
|
|
||||||
|
1. Create an issue first to discuss *significant* changes
|
||||||
|
2. Fork the repository and create a new branch for your feature
|
||||||
|
3. Follow the existing code style
|
||||||
|
4. Include appropriate documentation updates
|
||||||
|
5. Test your changes thoroughly
|
||||||
|
|
||||||
|
Thank you for helping make Hugo ʕ•ᴥ•ʔ Bear Blog better! 🎉
|
|
@ -64,8 +64,9 @@ hugo new blog/my-new-post.md
|
||||||
|
|
||||||
Add a `custom_head.html`-file to your `layouts/partials`-directory. In there you may add a `<style>`-tag, *or* you may add a `<link>`-tag referencing your own `custom.css` (in case you prefer to have a separate `.css`-file). Check out the [`style.html`](https://github.com/janraasch/hugo-bearblog/blob/master/layouts/partials/style.html)-file to find out which CSS-styles are applied by default.
|
Add a `custom_head.html`-file to your `layouts/partials`-directory. In there you may add a `<style>`-tag, *or* you may add a `<link>`-tag referencing your own `custom.css` (in case you prefer to have a separate `.css`-file). Check out the [`style.html`](https://github.com/janraasch/hugo-bearblog/blob/master/layouts/partials/style.html)-file to find out which CSS-styles are applied by default.
|
||||||
|
|
||||||
## Issues / Feedback / Contributing
|
## Contributing 🤝
|
||||||
Please use [GitHub issues](https://github.com/janraasch/hugo-bearblog/issues) and [Pull Requests](https://github.com/janraasch/hugo-bearblog/pulls).
|
|
||||||
|
Interested in contributing to Hugo ʕ•ᴥ•ʔ Bear Blog? Thanks for your interest! Please take a look at our [Contributing Guidelines](CONTRIBUTING.md) first.
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
Run the `exampleSite` locally via
|
Run the `exampleSite` locally via
|
||||||
|
|
Loading…
Add table
Reference in a new issue