Skip to content

Commit

Permalink
Merge pull request apache#8 from OpenLineage/julienledem-contributing
Browse files Browse the repository at this point in the history
Create CONTRIBUTING.md
  • Loading branch information
julienledem authored Dec 16, 2020
2 parents 12545eb + 7e408d4 commit 6ad9c0e
Showing 1 changed file with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Contributing Guide

## Reporting an Issue

Please use the [issues][issues] section of the OpenLineage 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 provide steps to reproduce it and tag your issue with "bug"

## 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.

## Proposing changes

Create an issue and prefix the description with "[PROPOSAL]"

In the description provide the following sections:
- Purpose (Why?): What is the use case this is for.
- Proposed implementation (How?): Quick description of how do you propose to implement it. Are you proposing a new facet?

This can be just a couple paragraphs to start with.

## 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.

Look 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.


[issues]: https://github.com/OpenLineage/OpenLineage/issues
[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/OpenLineage/OpenLineage/labels/good%20first%20issue
[helpwantedissues]: https://github.com/OpenLineage/OpenLineage/labels/help%20wanted

0 comments on commit 6ad9c0e

Please sign in to comment.