Skip to content
This repository has been archived by the owner on Aug 4, 2023. It is now read-only.

Made improvements to CONTRIBUTING.md #791

Merged
merged 2 commits into from
Oct 12, 2022
Merged

Conversation

kavyabhat02
Copy link
Contributor

Fixes

Fixes WordPress/openverse#1413 by @AetherUnbound

Description

Made improvements to CONTRIBUTING.md.

Checklist

  • My pull request has a descriptive title (not a vague title like Update 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.

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.

@kavyabhat02 kavyabhat02 requested a review from a team as a code owner October 11, 2022 01:38
@openverse-bot openverse-bot added 📄 aspect: text Concerns the textual material in the repository 🛠 goal: fix Bug fix 🟨 priority: medium Not blocking but should be addressed soon labels Oct 11, 2022
Copy link
Contributor

@AetherUnbound AetherUnbound left a comment

Choose a reason for hiding this comment

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

Thank you for the contribution! I have one recommended change. Additionally, it looks like the linting step is failing locally. Do you mind running just lint locally and committing the changes it recommends?

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated
@@ -3,18 +3,21 @@
Thank you for your interest in contributing to Openverse! This document is
a set of guidelines to help you contribute to this project.

Please refer to [CONTRIBUTING.md](https://github.com/WordPress/openverse/blob/0b5e24bd325da7b75db9484a268d7c8d197ae920/CONTRIBUTING.md) for a
Copy link
Member

Choose a reason for hiding this comment

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

We should update the link so that it always points to the latest.

Suggested change
Please refer to [CONTRIBUTING.md](https://github.com/WordPress/openverse/blob/0b5e24bd325da7b75db9484a268d7c8d197ae920/CONTRIBUTING.md) for a
Please refer to [CONTRIBUTING.md](./CONTRIBUTING.md) for a

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This would point to the file in the openverse-catalog repo, right? The requirement was to direct users to the main repo, so I put up the entire link.

Copy link
Contributor

Choose a reason for hiding this comment

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

@dhruvkb we intentionally wanted to point to the larger contributing file in the main repo!

@kavyabhat02
Copy link
Contributor Author

kavyabhat02 commented Oct 11, 2022

Thanks for the direction to run just lint! It turns out that I hadn't trimmed trailing whitespace, and that's why the linting step failed.

Copy link
Contributor

@AetherUnbound AetherUnbound left a comment

Choose a reason for hiding this comment

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

Looks great, thanks again @kavyabhat02!

@AetherUnbound AetherUnbound requested a review from dhruvkb October 11, 2022 20:16
Copy link
Contributor

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

Looks good to me as well, thanks :)

@dhruvkb dhruvkb merged commit 3217ed5 into WordPress:main Oct 12, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
📄 aspect: text Concerns the textual material in the repository 🛠 goal: fix Bug fix 🟨 priority: medium Not blocking but should be addressed soon
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Various improvements to CONTRIBUTING.md
5 participants