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

Document contributor roles and add maintainers list #734

Merged
merged 11 commits into from
Dec 4, 2023
4 changes: 4 additions & 0 deletions docs/contributing.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _contributing:

Cosmos Contributing Guide
=========================

Expand All @@ -6,6 +8,8 @@ All contributions, bug reports, bug fixes, documentation improvements, enhanceme
As contributors and maintainers to this project, you are expected to abide by the
`Contributor Code of Conduct <https://github.com/astronomer/astronomer-cosmos/blob/main/CODE_OF_CONDUCT.md>`_.

Learn more about the contributors roles in :ref:`contributors-roles`.

Overview
________

Expand Down
56 changes: 56 additions & 0 deletions docs/contributors-roles.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
.. _contributors-roles:

Contributors roles
tatiana marked this conversation as resolved.
Show resolved Hide resolved
==================

Contributors are welcome and are greatly appreciated! Every little bit helps, and we give credit to them.

This document aims to explain the current roles in the Astronomer Cosmos project.
For more information, check :ref:`contributing` and :ref:`contributors`.


Contributors
------------

A contributor is anyone who wants to contribute code, documentation, tests, ideas, or anything to the Astronomer Cosmos project.

Cosmos contributors can be found in the Astronomer Cosmos Github `insights page <https://github.com/astronomer/astronomer-cosmos/graphs/contributors>`_ and in the `#airflow-dbt <https://join.slack.com/t/apache-airflow/shared_invite/zt-1zy8e8h85-es~fn19iMzUmkhPwnyRT6Q>`_ Slack channel.

Contributors are responsible for:

* Fixing bugs
tatiana marked this conversation as resolved.
Show resolved Hide resolved
* Refactoring code
* Improving processes and tooling
* Adding features
* Improving the documentation
* Making/answering questions in the #airflow-dbt Slack channel


Committers/Maintainers
tatiana marked this conversation as resolved.
Show resolved Hide resolved
----------------------

Committers are community members with write access to the `Astronomer Cosmos Github repository <https://github.com/astronomer/astronomer-cosmos>`_.
They can modify the code and the documentation and accept others' contributions to the repo.

Check :ref:`contributors` for the official list of Astronomer Cosmos committers.

Committers have the same responsibilities as standard contributors and also perform the following actions:

* Reviewing & merging pull-requests
* Scanning and responding to GitHub issues, helping triaging them

If you know you are not going to be able to contribute for a long time (for instance, due to a change of job or circumstances), you should inform other maintainers, and we will mark you as "emeritus".
Emeritus committers will no longer have write access to the repo.
As merit earned never expires, once an emeritus committer becomes active again, they can simply email another maintainer from Astronomer and ask to be reinstated.

tatiana marked this conversation as resolved.
Show resolved Hide resolved
Pre-requisites to becoming a committer
.......................................

General prerequisites that we look for in all candidates:

1. Consistent contribution over last few months
2. Visibility on discussions on the Slack channel or GitHub issues/discussions
3. Contributions to community health and project's sustainability for the long-term
4. Understands the project's contributors guidelines :ref:`contributing`.
tatiana marked this conversation as resolved.
Show resolved Hide resolved
Astronomer is responsible and accountable for releasing new versions of Cosmos in PyPI <https://pypi.org/project/astronomer-cosmos/>, following the milestones <https://github.com/astronomer/astronomer-cosmos/milestones>.
Astronomer has the right to grant and revoke write access permissions to the project's official repository for any reason it sees fit.
26 changes: 26 additions & 0 deletions docs/contributors.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
.. _contributors:
Contributors
============

There are different ways people can contribute to Astronomer Cosmos.
Learn more about the project contributors roles in :ref:`contributors-roles`.

Committers/Maintainers
tatiana marked this conversation as resolved.
Show resolved Hide resolved
----------------------

tatiana marked this conversation as resolved.
Show resolved Hide resolved
* Chris Hronek (`@chrishronek <https://github.com/chrishronek>`_)
* Harel Shein (`@harels <https://github.com/harels>`_)
* Julian LaNeve (`@jlaneve <https://github.com/jlaneve>`_)
* Tatiana Al-Chueyr (`@tatiana <https://github.com/tatiana>`_)


Emeritus Committers/Maintainers
tatiana marked this conversation as resolved.
Show resolved Hide resolved
-------------------------------

(none at the moment)

Contributors
------------

Many people are improving Astronomer Cosmos each day.
Find more contributors `in our Github page <https://github.com/astronomer/astronomer-cosmos/graphs/contributors>`_ and in the `#airflow-dbt <https://join.slack.com/t/apache-airflow/shared_invite/zt-1zy8e8h85-es~fn19iMzUmkhPwnyRT6Q>`_ Slack channel.
3 changes: 2 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,8 @@ __________________

All contributions, bug reports, bug fixes, documentation improvements, enhancements are welcome.

A detailed overview an how to contribute can be found in the `Contributing Guide <https://astronomer.github.io/astronomer-cosmos/contributing>`_.
A detailed overview on how to contribute can be found in the `Contributing Guide <https://astronomer.github.io/astronomer-cosmos/contributing>`_.
Find out more about `our contributors <https://astronomer.github.io/astronomer-cosmos/contributors>`_.

As contributors and maintainers to this project, you are expected to abide by the
`Contributor Code of Conduct <https://github.com/astronomer/astronomer-cosmos/blob/main/CODE_OF_CONDUCT.md>`_.
Expand Down
Loading