Contributing Guide

Reporting an Issue

The easiest way you can contribute to Amundsen is by creating issues. For that, please use the issues section of the Amundsen repository and search for a similar problem. If you don’t find it, submit your bug, question, proposal or feature request.

In the case of bugs, please be descriptive and, if possible, include a screenshot of the issue.

Creating Pull Requests

Before sending a Pull Request with significant changes, please use the issue tracker to discuss the potential improvements you want to make.

First-Time Contributors

If this is your first contribution to open source, you can follow this tutorial or check this video series to learn about the contribution workflow with GitHub.

We always have tickets labeled ‘good first issue’ and ‘help wanted’. These are a great starting point if you want to contribute. Don’t hesitate to ask questions about the issue if you are not sure about the strategy to follow.

Requesting a Feature

We have created a Roadmap document with our plans for next releases, however, we are open to hear your ideas for new features!

For that, you can create an issue and select the “Feature Proposal” template. Fill in as much information as possible, and if you can, add responses to the following questions:

  • We’ll need to add a new model or change any existing model?
  • What would the Migration Plan look like? Will it be backwards-compatible?
  • Which alternatives did you consider?

Setup

To start contributing to Amundsen, you need to set up your machine to develop with the project. For that, we have prepareda a Developer Guide that will guide you to set up your environment to develop locally with Amundsen.

Get Recognition

You can add yourself or somebody else to the contributors list by using the All Contributors bot.

Next Steps

Once you have your environment set and ready to go, you can check our documentation and the project’s Roadmap to see what’s coming.