File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 1+ # Contributing to mtlog
2+
3+ Thank you for your interest in contributing to mtlog!
4+
5+ ## Before You Start
6+
7+ - Check existing [ issues] ( https://github.com/willibrandon/mtlog/issues ) and [ pull requests] ( https://github.com/willibrandon/mtlog/pulls )
8+ - For significant changes, open an issue first to discuss your proposal
9+
10+ ## Development Setup
11+
12+ ``` bash
13+ # Clone the repository
14+ git clone https://github.com/willibrandon/mtlog.git
15+ cd mtlog
16+
17+ # Run tests
18+ go test ./...
19+
20+ # Run benchmarks
21+ go test -bench=. -benchmem ./...
22+
23+ # Run linter
24+ golangci-lint run
25+ ```
26+
27+ ## Code Guidelines
28+
29+ - Follow standard Go conventions and idioms
30+ - Keep the zero-allocation promise for simple logging paths
31+ - Add tests for new features (unit and integration where appropriate)
32+ - Update documentation and examples as needed
33+ - Ensure ` golangci-lint ` passes
34+
35+ ## Pull Request Process
36+
37+ 1 . Fork the repository
38+ 2 . Create a feature branch (` git checkout -b feature/amazing-feature ` )
39+ 3 . Make your changes
40+ 4 . Run tests and linter
41+ 5 . Commit with a descriptive message
42+ 6 . Push to your fork
43+ 7 . Open a pull request with a clear description
44+
45+ ## Testing
46+
47+ - Unit tests should be fast and focused
48+ - Integration tests require Docker for Seq, Elasticsearch, and Splunk
49+ - Use ` MemorySink ` for testing log output
50+ - Benchmark critical paths to ensure performance
51+
52+ ## Questions?
53+
54+ Open an issue or discussion - we're happy to help!
Original file line number Diff line number Diff line change @@ -638,7 +638,7 @@ See [testing.md](./docs/testing.md) for detailed integration test setup with Doc
638638
639639## Contributing
640640
641- Contributions are welcome! Please feel free to submit a Pull Request .
641+ Contributions are welcome! Please see our [ Contributing Guide ] ( CONTRIBUTING.md ) for details .
642642
643643## License
644644
You can’t perform that action at this time.
0 commit comments