CONTRIBUTING.md

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
• Look for good first issues to start with
• Review recently closed issues to avoid duplicates

Types of Contributions

1. Report Bugs: Use our Bug Report template
2. Request Features: Submit using Feature Request template
3. Improve Documentation: Create an issue with the documentation label
4. Report Performance Issues: Use our Performance Issue template
5. Request Dashboards: Submit using Dashboard Request template
6. Report Security Issues: Follow our Security Policy
7. Join Discussions: Participate in project 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
   • Work against the latest main branch
   • Focus on specific changes
   • Ensure all tests pass locally
   • Follow our 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. 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 organization to contribute to. Here is a list of highlighted repositories:

• charts
• 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
• #contributing-frontend

Where do I go from here?

• Set up your development environment