Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add steps on proposing changes to Marquez #2065

Merged
merged 3 commits into from
Aug 10, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions proposals/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Proposals

Marquez uses a _multi_-project structure and contains the modules [`api`](https://github.com/MarquezProject/marquez/tree/main/api), [`web`](https://github.com/MarquezProject/marquez/tree/main/web), [`clients`](https://github.com/MarquezProject/marquez/tree/main/clients), and [`chart`](https://github.com/MarquezProject/marquez/tree/main/chart). Below, we describe the process for proposing, documenting, and implementing changes to Marquez.


## Submitting a Proposal for Review

1. Open a [new issue](https://github.com/MarquezProject/marquez/issues/new) briefly describing your proposal
2. Work with Marquez [committers](https://github.com/MarquezProject/marquez/blob/main/COMMITTERS.md) to get your proposal reviewed

> **Note:** Your proposal can have one of two outcomes: _`accepted`_ or _`decline`_; if the proposal is _`declined`_, the process is done.

3. If the proposal is _`accepted`_, the proposal author **must** write a design doc using our [template](https://github.com/MarquezProject/marquez/blob/main/proposals/TEMPLATE.md) for new proposals

> **Note:** Your proposal **must** be added under [`proposals/`]() using the naming convention: `[#ISSUE]-[SHORT-NAME].md`, where `[#ISSUE]` is the GitHub issue in **Step 1**, and `[SHORT-NAME]` is a shortened name of your proposal (each word seperated by dashes(`-`)).

4. Open a pull request with your proposal for final discussion (please follow our [contributing](https://github.com/MarquezProject/marquez/blob/main/CONTRIBUTING.md) guide)

## Questions?

If you need help with the proposal process, please reach out to us on our [slack](http://bit.ly/MarquezSlack) channel.
25 changes: 25 additions & 0 deletions proposals/TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
[_Template for proposing changes to Marquez as documented [here](https://github.com/MarquezProject/marquez/blob/main/proposals/README.md)._]

# Proposal: [_Your Title Here_]

Author(s): [_Author, Co-author(s)_]

Created: [_YYYY-MM-DD_]

Dicussion: [_Link to issue with dicussion on the change being proposed._]

## Overview

[_A short summary of the proposal, background, and the problem being solved._]

## Proposal

[_The change being proposed._]

## Implementation

[_A description of implementation steps. We recommend you include any dependencies. If your change requires a database schema migration, please describe the schema modification(s) and whether it's a backwards-incompatible or backwards-compatible change._]

## Next Steps

[_A discussion of related issue(s) for this proposal, who will be assigned to work on them, timeline for when the change being proposed will be worked on, etc. **You may omit this section if there are none.**_]