GSoC Contributor Guideline - SigNoz

[pranay01]

SigNoz @ GSoC

We ❤️ open source

Below doc is a guideline for contributors participating in GSoC and interested in contributing to SigNoz. This doc is for our application in GSoC. The final organization list is not announced yet by Google. We will update this doc as the status of our application is updated.

Introduction

We are super excited to and look forward to supporting all interested contributors to participate and contribute to our open source project.

This document covers the process, expectations and guidelines for any interested contributor so that we can guide, mentor in the best possible manner.

Ideas

1. Existing issues
   Have a look into the Github issues page of this repository and look out for existing issues. If you found issues that you think you can implement, then that's amazing! Feel free to pick them up (make sure no one is actively assigned to the issue though).

2. Integrations and easy ways to deploy SigNoz in different environments
   Two key areas where we welcome new ideas is:

   a. Making it easier to deploy SigNoz in different environments. e.g. One click deploy in Digital Ocean, One Click deploy in GCP, AWS, Azure, or any other PaaS like Heroku. Sample issues
   Single click Heroku deploy option #43
   1 click deploy SigNoz on Digital Ocean #284

   b. Build integrations with other tools. e.g. Ability to send alerts in emails or integrations with other alert management tools like OpsGenie, PagerDuty. Sample issues
   Enable support for sending alerts on Pagerduty #463
   feat: Alert Channel For Email #623

3. New features
   Couldn't find any issue that piqued your interest? Well, the next option would be to make a new feature request (or any other kind of issue type) yourself! Try using SigNoz and if you find anything you felt like it was missing, then well open an issue as your submission to work on the project!

Process

The application process consists of next steps:

• Go through the list of ideas/issues you can take up in the previous section
• Join our slack community to interact with mentors in #gsoc channel about the idea/issue you are interested in
• After you have had initial chat on slack, start a discussion here in github with potential ideas for the project and add gsoc label to it
• Submit the application/proposal including all requirements at the Google Summer of Code Site.

Requirements

Requirements before submitting your proposal:

• Install latest release of SigNoz and play around with the product. Follow installation instructions here
• Check out our contribution guidelines

Important Links

• Slack Community
• Contribution Guidelines
• Docs
• Website