opensearch-project / opensearch-project/.github

Conflicting guidance on License Headers

Open
#98 0 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
No language data
Stars
41
Forks
74
Avg merge
3d 19h
Merged PRs (30d)
1

Description

The CONTRIBUTING.md file in this repository specifies a longer license header.

This conflicts with apparent (authoritative?) guidance posted in a comment on the alerting project repo here, although the qualification of "like this one" isn't clear:
https://github.com/opensearch-project/alerting/issues/136#issuecomment-966657180

There was an apparently more authoritative version in issue #21 and PR #29 where the CONTRIBUTING file was updated with a shorter version.
@dblock asked:

is the short version the preferred version, @hyandell?

@hyandell replied:

Yes, that's the preferred version.

But then @dblock updated the header in #76 to include the more expansive language presently in the header based on this issue: https://github.com/opensearch-project/opensearch-java/pull/178

That update stated that the change was "confirmed" but did not cite a reference.

But we still have some PRs updating per the older guidance such as https://github.com/opensearch-project/OpenSearch/pull/4657

My ask:

  1. Please confirm that the header in this repo's CONTRIBUTING file is the latest official guidance
  2. Suggest someone with the admin-powers to do so edit the conflicting guidance in the linked issues above to add an "update" which points to the latest guidance

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review CONTRIBUTING.md and compare its license-header guidance with the comment in alerting issue #136, issue #21, PR #29, and the update in #76. This requires an authoritative decision on which wording is current; done means confirming the official guidance and updating the conflicting linked issues to point to it.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.