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

Documentation for becoming a committer, reorganize contributing pages #3594

Merged
merged 5 commits into from
Jan 11, 2024

Conversation

AetherUnbound
Copy link
Collaborator

Fixes

No issue for this one, but it came up recently while adding a new committer that having a page describing the benefits of becoming a committer might be helpful!

Description

This PR makes a few changes to the documentation around contribution:

  • Adds a "current maintainers" page which lists the current active set of maintainers
  • Moves many of the contribution-related meta pages into a contribution subfolder in the documentation (redirects maintained)
  • Adds a page for what a committer is and what the benefits are, based on Apache Airflow's documentation

Testing Instructions

Check the rendered pages and make sure they make sense!

Checklist

  • My pull request has a descriptive title (not a vague title likeUpdate index.md).
  • My pull request targets the default branch of the repository (main) or a parent feature branch.
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible errors.
  • I ran the DAG documentation generator (if applicable).

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@AetherUnbound AetherUnbound requested a review from a team as a code owner December 28, 2023 00:06
@AetherUnbound AetherUnbound added 🟩 priority: low Low priority and doesn't need to be rushed 🌟 goal: addition Addition of new feature 📄 aspect: text Concerns the textual material in the repository 🧱 stack: documentation Related to Sphinx documentation labels Dec 28, 2023
Copy link
Contributor

@obulat obulat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice improvements!

documentation/meta/contribution/index.md Outdated Show resolved Hide resolved
Co-authored-by: Olga Bulat <obulat@gmail.com>
Copy link
Collaborator

@stacimc stacimc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

documentation/general/contributing.md Outdated Show resolved Hide resolved
Co-authored-by: Staci Mullins <63313398+stacimc@users.noreply.github.com>
@krysal krysal merged commit 0a9d07d into main Jan 11, 2024
37 checks passed
@krysal krysal deleted the feature/openverse-committer-guidelines branch January 11, 2024 21:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📄 aspect: text Concerns the textual material in the repository 🌟 goal: addition Addition of new feature 🟩 priority: low Low priority and doesn't need to be rushed 🧱 stack: documentation Related to Sphinx documentation
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

4 participants