Skip to content

Commit cc4dde7

Browse files
authored
Create CONTRIBUTING.md
1 parent 04ea0f4 commit cc4dde7

File tree

1 file changed

+43
-0
lines changed

1 file changed

+43
-0
lines changed

Diff for: CONTRIBUTING.md

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Contributing to Zerolog
2+
3+
Thank you for your interest in contributing to **Zerolog**!
4+
5+
Zerolog is a **feature-complete**, high-performance logging library designed to be **lean** and **non-bloated**. The focus of ongoing development is on **bug fixes**, **performance improvements**, and **modernization efforts** (such as keeping up with Go best practices and compatibility with newer Go versions).
6+
7+
## What We're Looking For
8+
9+
We welcome contributions in the following areas:
10+
11+
- **Bug Fixes**: If you find an issue or unexpected behavior, please open an issue and/or submit a fix.
12+
- **Performance Optimizations**: Improvements that reduce memory usage, allocation count, or CPU cycles without introducing complexity are appreciated.
13+
- **Modernization**: Compatibility updates for newer Go versions or idiomatic improvements that do not increase library size or complexity.
14+
- **Documentation Enhancements**: Corrections, clarifications, and improvements to documentation or code comments.
15+
16+
## What We're *Not* Looking For
17+
18+
Zerolog is intended to remain **minimalistic and efficient**. Therefore, we are **not accepting**:
19+
20+
- New features that add optional behaviors or extend API surface area.
21+
- Built-in support for frameworks or external systems (e.g., bindings, integrations).
22+
- General-purpose abstractions or configuration helpers.
23+
24+
If you're unsure whether a change aligns with the project's philosophy, feel free to open an issue for discussion before submitting a PR.
25+
26+
## Contributing Guidelines
27+
28+
1. **Fork the repository**
29+
2. **Create a branch** for your fix or improvement
30+
3. **Write tests** to cover your changes
31+
4. Ensure `go test ./...` passes
32+
5. Run `go fmt` and `go vet` to ensure code consistency
33+
6. **Submit a pull request** with a clear explanation of the motivation and impact
34+
35+
## Code Style
36+
37+
- Keep the code simple, efficient, and idiomatic.
38+
- Avoid introducing new dependencies.
39+
- Preserve backwards compatibility unless explicitly discussed.
40+
41+
---
42+
43+
We appreciate your effort in helping us keep Zerolog fast, minimal, and reliable!

0 commit comments

Comments
 (0)