From 94da3198136f6a91da4eec78fada19bdc777fb2e Mon Sep 17 00:00:00 2001 From: Tatiana Al-Chueyr Date: Mon, 4 Dec 2023 15:43:12 +0000 Subject: [PATCH] Document contributor roles and add maintainers list (#734) Add documentation about Astronomer Cosmos contributor roles and maintainers until now. --------- Co-authored-by: Harel Shein Co-authored-by: Julian LaNeve --- docs/contributing.rst | 4 +++ docs/contributors-roles.rst | 56 +++++++++++++++++++++++++++++++++++++ docs/contributors.rst | 26 +++++++++++++++++ docs/index.rst | 3 +- 4 files changed, 88 insertions(+), 1 deletion(-) create mode 100644 docs/contributors-roles.rst create mode 100644 docs/contributors.rst diff --git a/docs/contributing.rst b/docs/contributing.rst index f87553883..3e2ab6fe3 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -1,3 +1,5 @@ +.. _contributing: + Cosmos Contributing Guide ========================= @@ -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 `_. +Learn more about the contributors roles in :ref:`contributors-roles`. + Overview ________ diff --git a/docs/contributors-roles.rst b/docs/contributors-roles.rst new file mode 100644 index 000000000..7cddfb95f --- /dev/null +++ b/docs/contributors-roles.rst @@ -0,0 +1,56 @@ +.. _contributors-roles: + +Contributor roles +================== + +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 `_ and in the `#airflow-dbt `_ Slack channel. + +Contributors are responsible for: + +* Fixing bugs +* Refactoring code +* Improving processes and tooling +* Adding features +* Improving the documentation +* Making/answering questions in the #airflow-dbt Slack channel + + +Committers +---------------------- + +Committers are community members with write access to the `Astronomer Cosmos Github repository `_. +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. + +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`. +Astronomer is responsible and accountable for releasing new versions of Cosmos in PyPI , following the milestones . +Astronomer has the right to grant and revoke write access permissions to the project's official repository for any reason it sees fit. diff --git a/docs/contributors.rst b/docs/contributors.rst new file mode 100644 index 000000000..273358d3c --- /dev/null +++ b/docs/contributors.rst @@ -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 +---------------------- + +* Chris Hronek (`@chrishronek `_) +* Harel Shein (`@harels `_) +* Julian LaNeve (`@jlaneve `_) +* Tatiana Al-Chueyr (`@tatiana `_) + + +Emeritus Committers +------------------------------- + +(none at the moment) + +Contributors +------------ + +Many people are improving Astronomer Cosmos each day. +Find more contributors `in our Github page `_ and in the `#airflow-dbt `_ Slack channel. diff --git a/docs/index.rst b/docs/index.rst index f5cd3673d..0c7ab506c 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -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 `_. +A detailed overview on how to contribute can be found in the `Contributing Guide `_. +Find out more about `our contributors `_. As contributors and maintainers to this project, you are expected to abide by the `Contributor Code of Conduct `_.