Skip to content

Commit a8ea320

Browse files
committed
2 parents af8fc99 + b97a09e commit a8ea320

42 files changed

Lines changed: 5301 additions & 560 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

CONTRIBUTING.md

Lines changed: 158 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,158 @@
1+
# CONTRIBUTING.md
2+
3+
## 🚀 Welcome to the Hugo Project!
4+
5+
Thank you for your interest in contributing to Hugo! We value every kind of contribution, from code to documentation, bug reports, and community support. Let’s build something amazing together! 🌟
6+
7+
---
8+
9+
## 📋 Table of Contents
10+
11+
- [CONTRIBUTING.md](#contributingmd)
12+
- [🚀 Welcome to the Hugo Project!](#-welcome-to-the-hugo-project)
13+
- [📋 Table of Contents](#-table-of-contents)
14+
- [🧑‍💻 How to Contribute](#-how-to-contribute)
15+
- [🤝 Code of Conduct](#-code-of-conduct)
16+
- [🌈 Ways to Contribute](#-ways-to-contribute)
17+
- [🛠️ Development Setup](#️-development-setup)
18+
- [🐞 Reporting Issues](#-reporting-issues)
19+
- [📦 Submitting Pull Requests](#-submitting-pull-requests)
20+
- [📝 Commit Message Guidelines](#-commit-message-guidelines)
21+
- [🎉 Recognition](#-recognition)
22+
- [📬 Contact](#-contact)
23+
- [⚠️ Rules \& Reminders](#️-rules--reminders)
24+
25+
---
26+
27+
## 🧑‍💻 How to Contribute
28+
29+
1. **Fork** the repository and create your branch from `master`.
30+
2. **Make your changes**—whether it’s code, documentation, or bug fixes.
31+
3. **Test** your changes locally.
32+
4. **Submit a Pull Request** for review.
33+
34+
_If you’re new to open source, don’t worry! The Hugo team and community are here to help you get started._[^1][^2][^3]
35+
36+
---
37+
38+
## 🤝 Code of Conduct
39+
40+
We are committed to fostering a welcoming and inclusive environment. Please be respectful and considerate to others. For more details, see our [Code of Conduct](CODE_OF_CONDUCT.md). 🫶
41+
42+
---
43+
44+
## 🌈 Ways to Contribute
45+
46+
- 💬 **Answer questions** on the [forum](https://discourse.gohugo.io/)
47+
- 📝 **Improve documentation**
48+
- 🐛 **Report and squash bugs**
49+
- 🎨 **Create or improve themes**
50+
- 🚀 **Suggest or implement new features**
51+
- 🧹 **Help manage issues and discussions**
52+
53+
---
54+
55+
## 🛠️ Development Setup
56+
57+
Before you start, ensure you have:
58+
59+
- [ ] **Git**
60+
- [ ] **Go** (version 1.23.0 or later)
61+
- [ ] **C compiler** (GCC or Clang)
62+
- [ ] Updated your `PATH` as per [Go documentation](https://golang.org/doc/install)
63+
64+
For detailed setup instructions, see the [Development Guide](https://gohugo.io/contribute/development/).[^2]
65+
66+
---
67+
68+
## 🐞 Reporting Issues
69+
70+
- Search existing issues before opening a new one.
71+
- For bugs, include:
72+
- Hugo version (`hugo version`)
73+
- Operating system
74+
- Steps to reproduce
75+
- Use the appropriate repository for documentation or theme issues.
76+
77+
_If unsure, ask in the [forum](https://discourse.gohugo.io/) first!_ [^1][^3]
78+
79+
---
80+
81+
## 📦 Submitting Pull Requests
82+
83+
- Fork and make changes in a feature branch.
84+
- Reference an open issue (with `bug` or `enhancement` label) for non-trivial changes.
85+
- Add or update tests as needed.
86+
- Run `go fmt` and ensure `mage check` passes.
87+
- Squash your commits into one (`git rebase -i`).
88+
- Sign the CLA if prompted.
89+
- Add documentation for new features or changes.
90+
- Submit your PR and describe your changes clearly.
91+
92+
---
93+
94+
## 📝 Commit Message Guidelines
95+
96+
- Use clear, concise messages.
97+
- Prefix with type: `fix:`, `feat:`, `docs:`, `refactor:`, etc.
98+
- Example: `fix: resolve panic on empty config`
99+
100+
---
101+
102+
## 🎉 Recognition
103+
104+
All contributors are recognized and appreciated! Check out our [contributors list](humans.txt) and join our awesome community! 🏆
105+
106+
---
107+
108+
## 📬 Contact
109+
110+
For questions or help, reach out via:
111+
112+
- [Hugo Discussion Forum](https://discourse.gohugo.io/)
113+
- [GitHub Issues](https://github.com/gohugoio/hugo/issues)
114+
115+
---
116+
117+
> _Thank you for helping Hugo grow! Every contribution makes a difference. Happy coding!_ 💖
118+
119+
---
120+
121+
## ⚠️ Rules \& Reminders
122+
123+
- Be kind and constructive 🤗
124+
- No spam or off-topic content 🚫
125+
- Keep discussions public and transparent 💬
126+
- Respect review decisions and feedback 🙏
127+
- Have fun and learn! 🎓
128+
129+
---
130+
131+
_Ready to contribute? Fork, code, and PR away!_ 🚀
132+
133+
---
134+
135+
This guideline is based on Hugo’s official contribution process and best practices for open source projects[^1][^2][^4][^5].
136+
137+
<div style="text-align: center">⁂</div>
138+
139+
[^1]: https://github.com/gohugoio/hugo/blob/master/CONTRIBUTING.md
140+
141+
[^2]: https://gohugo.io/contribute/development/
142+
143+
[^3]: https://gohugo.io/contribute/
144+
145+
[^4]: https://contributing.md/how-to-build-contributing-md/
146+
147+
[^5]: https://github.com/nayafia/contributing-template
148+
149+
[^6]: https://discourse.gohugo.io/t/best-way-to-contribute/36839
150+
151+
[^7]: https://docs.github.com/articles/setting-guidelines-for-repository-contributors
152+
153+
[^8]: https://gohugobrasil.netlify.app/contribute/
154+
155+
[^9]: https://docs.hugoblox.com/reference/contribute/
156+
157+
[^10]: https://github.com/usnistgov/hugo-uswds/blob/main/CONTRIBUTING.md
158+

0 commit comments

Comments
 (0)