mirror of
https://git.mirrors.martin98.com/https://github.com/SigNoz/signoz
synced 2025-08-16 16:45:56 +08:00
e637487984
Co-authored-by: CheetoDa <31571545+Calm-Rock@users.noreply.github.com> Co-authored-by: Vibhu Pandey <vibhupandey28@gmail.com>
81 lines
3.7 KiB
Markdown
81 lines
3.7 KiB
Markdown
# Contributing Guidelines
|
|
|
|
Thank you for your interest in contributing to our project! We greatly value feedback and contributions from our community. This document will guide you through the contribution process.
|
|
|
|
## How can I contribute?
|
|
|
|
### Finding Issues to Work On
|
|
- Check our [existing open issues](https://github.com/SigNoz/signoz/issues?q=is%3Aopen+is%3Aissue)
|
|
- Look for [good first issues](https://github.com/SigNoz/signoz/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) to start with
|
|
- Review [recently closed issues](https://github.com/SigNoz/signoz/issues?q=is%3Aissue+is%3Aclosed) to avoid duplicates
|
|
|
|
### Types of Contributions
|
|
|
|
1. **Report Bugs**: Use our [Bug Report template](https://github.com/SigNoz/signoz/issues/new?assignees=&labels=&template=bug_report.md&title=)
|
|
2. **Request Features**: Submit using [Feature Request template](https://github.com/SigNoz/signoz/issues/new?assignees=&labels=&template=feature_request.md&title=)
|
|
3. **Improve Documentation**: Create an issue with the `documentation` label
|
|
4. **Report Performance Issues**: Use our [Performance Issue template](https://github.com/SigNoz/signoz/issues/new?assignees=&labels=&template=performance-issue-report.md&title=)
|
|
5. **Request Dashboards**: Submit using [Dashboard Request template](https://github.com/SigNoz/signoz/issues/new?assignees=&labels=dashboard-template&projects=&template=request_dashboard.md&title=%5BDashboard+Request%5D+)
|
|
6. **Report Security Issues**: Follow our [Security Policy](https://github.com/SigNoz/signoz/security/policy)
|
|
7. **Join Discussions**: Participate in [project discussions](https://github.com/SigNoz/signoz/discussions)
|
|
|
|
### Creating Helpful Issues
|
|
|
|
When creating issues, include:
|
|
|
|
- **For Feature Requests**:
|
|
- Clear use case and requirements
|
|
- Proposed solution or improvement
|
|
- Any open questions or considerations
|
|
|
|
- **For Bug Reports**:
|
|
- Step-by-step reproduction steps
|
|
- Version information
|
|
- Relevant environment details
|
|
- Any modifications you've made
|
|
- Expected vs actual behavior
|
|
|
|
### Submitting Pull Requests
|
|
|
|
1. **Development**:
|
|
- Setup your [development environment](docs/contributing/development.md)
|
|
- Work against the latest `main` branch
|
|
- Focus on specific changes
|
|
- Ensure all tests pass locally
|
|
- Follow our [commit convention](#commit-convention)
|
|
|
|
2. **Submit PR**:
|
|
- Ensure your branch can be auto-merged
|
|
- Address any CI failures
|
|
- Respond to review comments promptly
|
|
|
|
For substantial changes, please split your contribution into multiple PRs:
|
|
|
|
1. First PR: Overall structure (README, configurations, interfaces)
|
|
2. Second PR: Core implementation (split further if needed)
|
|
3. Final PR: Documentation updates and end-to-end tests
|
|
|
|
### Commit Convention
|
|
|
|
We follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/). All commits and PRs should include type specifiers (e.g., `feat:`, `fix:`, `docs:`, etc.).
|
|
|
|
## How can I contribute to other repositories?
|
|
|
|
You can find other repositories in the [SigNoz](https://github.com/SigNoz) organization to contribute to. Here is a list of **highlighted** repositories:
|
|
|
|
- [charts](https://github.com/SigNoz/charts)
|
|
- [dashboards](https://github.com/SigNoz/dashboards)
|
|
|
|
Each repository has its own contributing guidelines. Please refer to the guidelines of the repository you want to contribute to.
|
|
|
|
## How can I get help?
|
|
|
|
Need assistance? Join our Slack community:
|
|
- [`#contributing`](https://signoz-community.slack.com/archives/C01LWQ8KS7M)
|
|
- [`#contributing-frontend`](https://signoz-community.slack.com/archives/C027134DM8B)
|
|
|
|
## Where do I go from here?
|
|
|
|
- Set up your [development environment](docs/contributing/development.md)
|
|
- Deploy and observe [SigNoz in action with OpenTelemetry Demo Application](docs/otel-demo-docs.md)
|