Unverified Commit aa7d0f80 authored by Marcos Iglesias's avatar Marcos Iglesias Committed by GitHub

Adds Contributing document, bug and feature request templates (#449)

* Adds Contributing document, bug and feature request templates

* Adds Tao comments
parent e0723b57
# Contributing Guide
## Reporting an Issue
The easiest way you can contribute to Amundsen is by creating issues. For that, please use the [issues][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][issues] 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][contributionTutorial] or check [this video series][contributionVideos] to learn about the contribution workflow with GitHub.
We always have tickets labeled ['good first issue'][goodFirstIssues] and ['help wanted'][helpWantedIssues]. 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][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][developerGuide] 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][allContributorsBot].
## Next Steps
Once you have your environment set and ready to go, you can check our [documentation][documentationHomepage] and the project's [Roadmap][roadmap] to see what's coming.
[issues]: https://github.com/lyft/amundsen/issues
[allContributorsBot]: https://allcontributors.org/docs/en/bot/usage
[contributionTutorial]: https://github.com/firstcontributions/first-contributions#first-contributions
[contributionVideos]: https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github
[goodFirstIssues]: https://github.com/lyft/amundsen/labels/good%20first%20issue
[helpWantedIssues]: https://github.com/lyft/amundsen/labels/help%20wanted
[developerGuide]: https://lyft.github.io/amundsen/developer_guide/
[roadmap]: https://lyft.github.io/amundsen/roadmap/
[documentationHomepage]: https://lyft.github.io/amundsen/
---
name: Bug Report
about: Create a bug report
title: Bug Report
labels: bug
assignees: ''
---
<!--- Provide a general summary of the issue in the Title above -->
<!--- Look through existing open and closed issues to see if someone has reported the issue before -->
## Expected Behavior
<!--- Tell us what should happen -->
## Current Behavior
<!--- Tell us what happens instead of the expected behavior -->
## Possible Solution
<!--- Not obligatory, but suggest a fix/reason for the bug -->
## Steps to Reproduce
<!--- Provide a link to a live example, or an unambiguous set of steps to -->
<!--- reproduce this bug. Include code to reproduce, if relevant -->
1.
2.
3.
4.
## Screenshots (if appropriate)
## Context
<!--- How has this issue affected you? -->
<!--- Providing context helps us come up with a solution that is most useful in the real world -->
## Your Environment
<!--- Include as many relevant details about the environment you experienced the bug in -->
* Amunsen version used:
* Data warehouse stores:
* Deployment (k8s or native):
* Link to your fork or repository:
\ No newline at end of file
---
name: Feature Request
about: Create a feature request
title: Feature Proposal
labels: feature proposal
assignees: ''
---
<!--- Provide a general summary of the feature request or improvement in the Title above -->
<!--- Look through existing open and closed feature proposals to see if someone has asked for the feature before -->
## Expected Behavior or Use Case
<!--- Tell us how it should work -->
## Service or Ingestion ETL
<!--- Tell us to which service or component this request is related to -->
## Possible Implementation
<!--- Not obligatory, suggest ideas of how to implement the addition or change -->
## Example Screenshots (if appropriate):
## Context
<!--- Why do you need this feature or improvement? What is your use case? What are you trying to accomplish? -->
<!--- Providing context helps us come up with a solution that is most useful in the real world -->
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment